@sp-api-sdk/fulfillment-inbound-api-2024-03-20 3.3.10 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (455) hide show
  1. package/README.md +7 -8
  2. package/dist/index.cjs +3628 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +5200 -0
  5. package/dist/index.d.ts +5200 -0
  6. package/dist/index.js +3582 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +26 -12
  9. package/dist/cjs/api-model/api/fulfillment-inbound-api.js +0 -3131
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/address-input.js +0 -15
  16. package/dist/cjs/api-model/models/address.js +0 -15
  17. package/dist/cjs/api-model/models/all-owners-constraint.js +0 -22
  18. package/dist/cjs/api-model/models/appointment-slot-time.js +0 -15
  19. package/dist/cjs/api-model/models/appointment-slot.js +0 -15
  20. package/dist/cjs/api-model/models/box-content-information-source.js +0 -24
  21. package/dist/cjs/api-model/models/box-input.js +0 -15
  22. package/dist/cjs/api-model/models/box-requirements.js +0 -15
  23. package/dist/cjs/api-model/models/box-update-input.js +0 -15
  24. package/dist/cjs/api-model/models/box.js +0 -15
  25. package/dist/cjs/api-model/models/cancel-inbound-plan-response.js +0 -15
  26. package/dist/cjs/api-model/models/cancel-self-ship-appointment-request.js +0 -15
  27. package/dist/cjs/api-model/models/cancel-self-ship-appointment-response.js +0 -15
  28. package/dist/cjs/api-model/models/carrier-appointment.js +0 -15
  29. package/dist/cjs/api-model/models/carrier.js +0 -15
  30. package/dist/cjs/api-model/models/compliance-detail.js +0 -15
  31. package/dist/cjs/api-model/models/confirm-delivery-window-options-response.js +0 -15
  32. package/dist/cjs/api-model/models/confirm-packing-option-response.js +0 -15
  33. package/dist/cjs/api-model/models/confirm-placement-option-response.js +0 -15
  34. package/dist/cjs/api-model/models/confirm-shipment-content-update-preview-response.js +0 -15
  35. package/dist/cjs/api-model/models/confirm-transportation-options-request.js +0 -15
  36. package/dist/cjs/api-model/models/confirm-transportation-options-response.js +0 -15
  37. package/dist/cjs/api-model/models/contact-information.js +0 -15
  38. package/dist/cjs/api-model/models/content-update-preview.js +0 -15
  39. package/dist/cjs/api-model/models/create-inbound-plan-request.js +0 -15
  40. package/dist/cjs/api-model/models/create-inbound-plan-response.js +0 -15
  41. package/dist/cjs/api-model/models/create-marketplace-item-labels-request.js +0 -15
  42. package/dist/cjs/api-model/models/create-marketplace-item-labels-response.js +0 -15
  43. package/dist/cjs/api-model/models/currency.js +0 -15
  44. package/dist/cjs/api-model/models/custom-placement-input.js +0 -15
  45. package/dist/cjs/api-model/models/dates.js +0 -15
  46. package/dist/cjs/api-model/models/delivery-window-option.js +0 -15
  47. package/dist/cjs/api-model/models/dimensions.js +0 -15
  48. package/dist/cjs/api-model/models/document-download.js +0 -15
  49. package/dist/cjs/api-model/models/error-list.js +0 -15
  50. package/dist/cjs/api-model/models/freight-information.js +0 -15
  51. package/dist/cjs/api-model/models/generate-delivery-window-options-response.js +0 -15
  52. package/dist/cjs/api-model/models/generate-packing-options-response.js +0 -15
  53. package/dist/cjs/api-model/models/generate-placement-options-request.js +0 -15
  54. package/dist/cjs/api-model/models/generate-placement-options-response.js +0 -15
  55. package/dist/cjs/api-model/models/generate-self-ship-appointment-slots-request.js +0 -15
  56. package/dist/cjs/api-model/models/generate-self-ship-appointment-slots-response.js +0 -15
  57. package/dist/cjs/api-model/models/generate-shipment-content-update-previews-request.js +0 -15
  58. package/dist/cjs/api-model/models/generate-shipment-content-update-previews-response.js +0 -15
  59. package/dist/cjs/api-model/models/generate-transportation-options-request.js +0 -15
  60. package/dist/cjs/api-model/models/generate-transportation-options-response.js +0 -15
  61. package/dist/cjs/api-model/models/get-delivery-challan-document-response.js +0 -15
  62. package/dist/cjs/api-model/models/get-self-ship-appointment-slots-response.js +0 -15
  63. package/dist/cjs/api-model/models/inbound-operation-status.js +0 -15
  64. package/dist/cjs/api-model/models/inbound-plan-summary.js +0 -15
  65. package/dist/cjs/api-model/models/inbound-plan.js +0 -15
  66. package/dist/cjs/api-model/models/incentive.js +0 -15
  67. package/dist/cjs/api-model/models/index.js +0 -156
  68. package/dist/cjs/api-model/models/item-input.js +0 -15
  69. package/dist/cjs/api-model/models/item-label-page-type.js +0 -32
  70. package/dist/cjs/api-model/models/item.js +0 -15
  71. package/dist/cjs/api-model/models/label-owner.js +0 -24
  72. package/dist/cjs/api-model/models/label-print-type.js +0 -23
  73. package/dist/cjs/api-model/models/list-delivery-window-options-response.js +0 -15
  74. package/dist/cjs/api-model/models/list-inbound-plan-boxes-response.js +0 -15
  75. package/dist/cjs/api-model/models/list-inbound-plan-items-response.js +0 -15
  76. package/dist/cjs/api-model/models/list-inbound-plan-pallets-response.js +0 -15
  77. package/dist/cjs/api-model/models/list-inbound-plans-response.js +0 -15
  78. package/dist/cjs/api-model/models/list-item-compliance-details-response.js +0 -15
  79. package/dist/cjs/api-model/models/list-packing-group-boxes-response.js +0 -15
  80. package/dist/cjs/api-model/models/list-packing-group-items-response.js +0 -15
  81. package/dist/cjs/api-model/models/list-packing-options-response.js +0 -15
  82. package/dist/cjs/api-model/models/list-placement-options-response.js +0 -15
  83. package/dist/cjs/api-model/models/list-prep-details-response.js +0 -15
  84. package/dist/cjs/api-model/models/list-shipment-boxes-response.js +0 -15
  85. package/dist/cjs/api-model/models/list-shipment-content-update-previews-response.js +0 -15
  86. package/dist/cjs/api-model/models/list-shipment-items-response.js +0 -15
  87. package/dist/cjs/api-model/models/list-shipment-pallets-response.js +0 -15
  88. package/dist/cjs/api-model/models/list-transportation-options-response.js +0 -15
  89. package/dist/cjs/api-model/models/ltl-tracking-detail-input.js +0 -15
  90. package/dist/cjs/api-model/models/ltl-tracking-detail.js +0 -15
  91. package/dist/cjs/api-model/models/model-error.js +0 -15
  92. package/dist/cjs/api-model/models/msku-prep-detail-input.js +0 -15
  93. package/dist/cjs/api-model/models/msku-prep-detail.js +0 -15
  94. package/dist/cjs/api-model/models/msku-quantity.js +0 -15
  95. package/dist/cjs/api-model/models/operation-problem.js +0 -15
  96. package/dist/cjs/api-model/models/operation-status.js +0 -24
  97. package/dist/cjs/api-model/models/owner-constraint.js +0 -24
  98. package/dist/cjs/api-model/models/package-grouping-input.js +0 -15
  99. package/dist/cjs/api-model/models/packing-configuration.js +0 -15
  100. package/dist/cjs/api-model/models/packing-option-summary.js +0 -15
  101. package/dist/cjs/api-model/models/packing-option.js +0 -15
  102. package/dist/cjs/api-model/models/pagination.js +0 -15
  103. package/dist/cjs/api-model/models/pallet-input.js +0 -15
  104. package/dist/cjs/api-model/models/pallet.js +0 -15
  105. package/dist/cjs/api-model/models/placement-option-summary.js +0 -15
  106. package/dist/cjs/api-model/models/placement-option.js +0 -15
  107. package/dist/cjs/api-model/models/prep-category.js +0 -35
  108. package/dist/cjs/api-model/models/prep-instruction.js +0 -15
  109. package/dist/cjs/api-model/models/prep-owner.js +0 -24
  110. package/dist/cjs/api-model/models/prep-type.js +0 -37
  111. package/dist/cjs/api-model/models/quote.js +0 -15
  112. package/dist/cjs/api-model/models/reason-comment.js +0 -30
  113. package/dist/cjs/api-model/models/region.js +0 -15
  114. package/dist/cjs/api-model/models/requested-updates.js +0 -15
  115. package/dist/cjs/api-model/models/schedule-self-ship-appointment-request.js +0 -15
  116. package/dist/cjs/api-model/models/schedule-self-ship-appointment-response.js +0 -15
  117. package/dist/cjs/api-model/models/selected-delivery-window.js +0 -15
  118. package/dist/cjs/api-model/models/self-ship-appointment-details.js +0 -15
  119. package/dist/cjs/api-model/models/self-ship-appointment-slots-availability.js +0 -15
  120. package/dist/cjs/api-model/models/set-packing-information-request.js +0 -15
  121. package/dist/cjs/api-model/models/set-packing-information-response.js +0 -15
  122. package/dist/cjs/api-model/models/set-prep-details-request.js +0 -15
  123. package/dist/cjs/api-model/models/set-prep-details-response.js +0 -15
  124. package/dist/cjs/api-model/models/shipment-destination.js +0 -15
  125. package/dist/cjs/api-model/models/shipment-source.js +0 -15
  126. package/dist/cjs/api-model/models/shipment-summary.js +0 -15
  127. package/dist/cjs/api-model/models/shipment-transportation-configuration.js +0 -15
  128. package/dist/cjs/api-model/models/shipment.js +0 -15
  129. package/dist/cjs/api-model/models/shipping-configuration.js +0 -15
  130. package/dist/cjs/api-model/models/shipping-requirements.js +0 -15
  131. package/dist/cjs/api-model/models/spd-tracking-detail-input.js +0 -15
  132. package/dist/cjs/api-model/models/spd-tracking-detail.js +0 -15
  133. package/dist/cjs/api-model/models/spd-tracking-item-input.js +0 -15
  134. package/dist/cjs/api-model/models/spd-tracking-item.js +0 -15
  135. package/dist/cjs/api-model/models/stackability.js +0 -23
  136. package/dist/cjs/api-model/models/tax-details.js +0 -15
  137. package/dist/cjs/api-model/models/tax-rate.js +0 -15
  138. package/dist/cjs/api-model/models/tracking-details-input.js +0 -15
  139. package/dist/cjs/api-model/models/tracking-details.js +0 -15
  140. package/dist/cjs/api-model/models/transportation-option.js +0 -15
  141. package/dist/cjs/api-model/models/transportation-selection.js +0 -15
  142. package/dist/cjs/api-model/models/unit-of-measurement.js +0 -23
  143. package/dist/cjs/api-model/models/unit-of-weight.js +0 -23
  144. package/dist/cjs/api-model/models/update-inbound-plan-name-request.js +0 -15
  145. package/dist/cjs/api-model/models/update-item-compliance-details-request.js +0 -15
  146. package/dist/cjs/api-model/models/update-item-compliance-details-response.js +0 -15
  147. package/dist/cjs/api-model/models/update-shipment-name-request.js +0 -15
  148. package/dist/cjs/api-model/models/update-shipment-source-address-request.js +0 -15
  149. package/dist/cjs/api-model/models/update-shipment-source-address-response.js +0 -15
  150. package/dist/cjs/api-model/models/update-shipment-tracking-details-request.js +0 -15
  151. package/dist/cjs/api-model/models/update-shipment-tracking-details-response.js +0 -15
  152. package/dist/cjs/api-model/models/weight-range.js +0 -15
  153. package/dist/cjs/api-model/models/weight.js +0 -15
  154. package/dist/cjs/api-model/models/window-input.js +0 -15
  155. package/dist/cjs/api-model/models/window.js +0 -15
  156. package/dist/cjs/client.js +0 -13
  157. package/dist/cjs/index.js +0 -19
  158. package/dist/es/api-model/api/fulfillment-inbound-api.js +0 -3121
  159. package/dist/es/api-model/api.js +0 -14
  160. package/dist/es/api-model/base.js +0 -44
  161. package/dist/es/api-model/common.js +0 -110
  162. package/dist/es/api-model/configuration.js +0 -94
  163. package/dist/es/api-model/index.js +0 -16
  164. package/dist/es/api-model/models/address-input.js +0 -14
  165. package/dist/es/api-model/models/address.js +0 -14
  166. package/dist/es/api-model/models/all-owners-constraint.js +0 -19
  167. package/dist/es/api-model/models/appointment-slot-time.js +0 -14
  168. package/dist/es/api-model/models/appointment-slot.js +0 -14
  169. package/dist/es/api-model/models/box-content-information-source.js +0 -21
  170. package/dist/es/api-model/models/box-input.js +0 -14
  171. package/dist/es/api-model/models/box-requirements.js +0 -14
  172. package/dist/es/api-model/models/box-update-input.js +0 -14
  173. package/dist/es/api-model/models/box.js +0 -14
  174. package/dist/es/api-model/models/cancel-inbound-plan-response.js +0 -14
  175. package/dist/es/api-model/models/cancel-self-ship-appointment-request.js +0 -14
  176. package/dist/es/api-model/models/cancel-self-ship-appointment-response.js +0 -14
  177. package/dist/es/api-model/models/carrier-appointment.js +0 -14
  178. package/dist/es/api-model/models/carrier.js +0 -14
  179. package/dist/es/api-model/models/compliance-detail.js +0 -14
  180. package/dist/es/api-model/models/confirm-delivery-window-options-response.js +0 -14
  181. package/dist/es/api-model/models/confirm-packing-option-response.js +0 -14
  182. package/dist/es/api-model/models/confirm-placement-option-response.js +0 -14
  183. package/dist/es/api-model/models/confirm-shipment-content-update-preview-response.js +0 -14
  184. package/dist/es/api-model/models/confirm-transportation-options-request.js +0 -14
  185. package/dist/es/api-model/models/confirm-transportation-options-response.js +0 -14
  186. package/dist/es/api-model/models/contact-information.js +0 -14
  187. package/dist/es/api-model/models/content-update-preview.js +0 -14
  188. package/dist/es/api-model/models/create-inbound-plan-request.js +0 -14
  189. package/dist/es/api-model/models/create-inbound-plan-response.js +0 -14
  190. package/dist/es/api-model/models/create-marketplace-item-labels-request.js +0 -14
  191. package/dist/es/api-model/models/create-marketplace-item-labels-response.js +0 -14
  192. package/dist/es/api-model/models/currency.js +0 -14
  193. package/dist/es/api-model/models/custom-placement-input.js +0 -14
  194. package/dist/es/api-model/models/dates.js +0 -14
  195. package/dist/es/api-model/models/delivery-window-option.js +0 -14
  196. package/dist/es/api-model/models/dimensions.js +0 -14
  197. package/dist/es/api-model/models/document-download.js +0 -14
  198. package/dist/es/api-model/models/error-list.js +0 -14
  199. package/dist/es/api-model/models/freight-information.js +0 -14
  200. package/dist/es/api-model/models/generate-delivery-window-options-response.js +0 -14
  201. package/dist/es/api-model/models/generate-packing-options-response.js +0 -14
  202. package/dist/es/api-model/models/generate-placement-options-request.js +0 -14
  203. package/dist/es/api-model/models/generate-placement-options-response.js +0 -14
  204. package/dist/es/api-model/models/generate-self-ship-appointment-slots-request.js +0 -14
  205. package/dist/es/api-model/models/generate-self-ship-appointment-slots-response.js +0 -14
  206. package/dist/es/api-model/models/generate-shipment-content-update-previews-request.js +0 -14
  207. package/dist/es/api-model/models/generate-shipment-content-update-previews-response.js +0 -14
  208. package/dist/es/api-model/models/generate-transportation-options-request.js +0 -14
  209. package/dist/es/api-model/models/generate-transportation-options-response.js +0 -14
  210. package/dist/es/api-model/models/get-delivery-challan-document-response.js +0 -14
  211. package/dist/es/api-model/models/get-self-ship-appointment-slots-response.js +0 -14
  212. package/dist/es/api-model/models/inbound-operation-status.js +0 -14
  213. package/dist/es/api-model/models/inbound-plan-summary.js +0 -14
  214. package/dist/es/api-model/models/inbound-plan.js +0 -14
  215. package/dist/es/api-model/models/incentive.js +0 -14
  216. package/dist/es/api-model/models/index.js +0 -140
  217. package/dist/es/api-model/models/item-input.js +0 -14
  218. package/dist/es/api-model/models/item-label-page-type.js +0 -29
  219. package/dist/es/api-model/models/item.js +0 -14
  220. package/dist/es/api-model/models/label-owner.js +0 -21
  221. package/dist/es/api-model/models/label-print-type.js +0 -20
  222. package/dist/es/api-model/models/list-delivery-window-options-response.js +0 -14
  223. package/dist/es/api-model/models/list-inbound-plan-boxes-response.js +0 -14
  224. package/dist/es/api-model/models/list-inbound-plan-items-response.js +0 -14
  225. package/dist/es/api-model/models/list-inbound-plan-pallets-response.js +0 -14
  226. package/dist/es/api-model/models/list-inbound-plans-response.js +0 -14
  227. package/dist/es/api-model/models/list-item-compliance-details-response.js +0 -14
  228. package/dist/es/api-model/models/list-packing-group-boxes-response.js +0 -14
  229. package/dist/es/api-model/models/list-packing-group-items-response.js +0 -14
  230. package/dist/es/api-model/models/list-packing-options-response.js +0 -14
  231. package/dist/es/api-model/models/list-placement-options-response.js +0 -14
  232. package/dist/es/api-model/models/list-prep-details-response.js +0 -14
  233. package/dist/es/api-model/models/list-shipment-boxes-response.js +0 -14
  234. package/dist/es/api-model/models/list-shipment-content-update-previews-response.js +0 -14
  235. package/dist/es/api-model/models/list-shipment-items-response.js +0 -14
  236. package/dist/es/api-model/models/list-shipment-pallets-response.js +0 -14
  237. package/dist/es/api-model/models/list-transportation-options-response.js +0 -14
  238. package/dist/es/api-model/models/ltl-tracking-detail-input.js +0 -14
  239. package/dist/es/api-model/models/ltl-tracking-detail.js +0 -14
  240. package/dist/es/api-model/models/model-error.js +0 -14
  241. package/dist/es/api-model/models/msku-prep-detail-input.js +0 -14
  242. package/dist/es/api-model/models/msku-prep-detail.js +0 -14
  243. package/dist/es/api-model/models/msku-quantity.js +0 -14
  244. package/dist/es/api-model/models/operation-problem.js +0 -14
  245. package/dist/es/api-model/models/operation-status.js +0 -21
  246. package/dist/es/api-model/models/owner-constraint.js +0 -21
  247. package/dist/es/api-model/models/package-grouping-input.js +0 -14
  248. package/dist/es/api-model/models/packing-configuration.js +0 -14
  249. package/dist/es/api-model/models/packing-option-summary.js +0 -14
  250. package/dist/es/api-model/models/packing-option.js +0 -14
  251. package/dist/es/api-model/models/pagination.js +0 -14
  252. package/dist/es/api-model/models/pallet-input.js +0 -14
  253. package/dist/es/api-model/models/pallet.js +0 -14
  254. package/dist/es/api-model/models/placement-option-summary.js +0 -14
  255. package/dist/es/api-model/models/placement-option.js +0 -14
  256. package/dist/es/api-model/models/prep-category.js +0 -32
  257. package/dist/es/api-model/models/prep-instruction.js +0 -14
  258. package/dist/es/api-model/models/prep-owner.js +0 -21
  259. package/dist/es/api-model/models/prep-type.js +0 -34
  260. package/dist/es/api-model/models/quote.js +0 -14
  261. package/dist/es/api-model/models/reason-comment.js +0 -27
  262. package/dist/es/api-model/models/region.js +0 -14
  263. package/dist/es/api-model/models/requested-updates.js +0 -14
  264. package/dist/es/api-model/models/schedule-self-ship-appointment-request.js +0 -14
  265. package/dist/es/api-model/models/schedule-self-ship-appointment-response.js +0 -14
  266. package/dist/es/api-model/models/selected-delivery-window.js +0 -14
  267. package/dist/es/api-model/models/self-ship-appointment-details.js +0 -14
  268. package/dist/es/api-model/models/self-ship-appointment-slots-availability.js +0 -14
  269. package/dist/es/api-model/models/set-packing-information-request.js +0 -14
  270. package/dist/es/api-model/models/set-packing-information-response.js +0 -14
  271. package/dist/es/api-model/models/set-prep-details-request.js +0 -14
  272. package/dist/es/api-model/models/set-prep-details-response.js +0 -14
  273. package/dist/es/api-model/models/shipment-destination.js +0 -14
  274. package/dist/es/api-model/models/shipment-source.js +0 -14
  275. package/dist/es/api-model/models/shipment-summary.js +0 -14
  276. package/dist/es/api-model/models/shipment-transportation-configuration.js +0 -14
  277. package/dist/es/api-model/models/shipment.js +0 -14
  278. package/dist/es/api-model/models/shipping-configuration.js +0 -14
  279. package/dist/es/api-model/models/shipping-requirements.js +0 -14
  280. package/dist/es/api-model/models/spd-tracking-detail-input.js +0 -14
  281. package/dist/es/api-model/models/spd-tracking-detail.js +0 -14
  282. package/dist/es/api-model/models/spd-tracking-item-input.js +0 -14
  283. package/dist/es/api-model/models/spd-tracking-item.js +0 -14
  284. package/dist/es/api-model/models/stackability.js +0 -20
  285. package/dist/es/api-model/models/tax-details.js +0 -14
  286. package/dist/es/api-model/models/tax-rate.js +0 -14
  287. package/dist/es/api-model/models/tracking-details-input.js +0 -14
  288. package/dist/es/api-model/models/tracking-details.js +0 -14
  289. package/dist/es/api-model/models/transportation-option.js +0 -14
  290. package/dist/es/api-model/models/transportation-selection.js +0 -14
  291. package/dist/es/api-model/models/unit-of-measurement.js +0 -20
  292. package/dist/es/api-model/models/unit-of-weight.js +0 -20
  293. package/dist/es/api-model/models/update-inbound-plan-name-request.js +0 -14
  294. package/dist/es/api-model/models/update-item-compliance-details-request.js +0 -14
  295. package/dist/es/api-model/models/update-item-compliance-details-response.js +0 -14
  296. package/dist/es/api-model/models/update-shipment-name-request.js +0 -14
  297. package/dist/es/api-model/models/update-shipment-source-address-request.js +0 -14
  298. package/dist/es/api-model/models/update-shipment-source-address-response.js +0 -14
  299. package/dist/es/api-model/models/update-shipment-tracking-details-request.js +0 -14
  300. package/dist/es/api-model/models/update-shipment-tracking-details-response.js +0 -14
  301. package/dist/es/api-model/models/weight-range.js +0 -14
  302. package/dist/es/api-model/models/weight.js +0 -14
  303. package/dist/es/api-model/models/window-input.js +0 -14
  304. package/dist/es/api-model/models/window.js +0 -14
  305. package/dist/es/client.js +0 -9
  306. package/dist/es/index.js +0 -3
  307. package/dist/types/api-model/api/fulfillment-inbound-api.d.ts +0 -2231
  308. package/dist/types/api-model/api.d.ts +0 -12
  309. package/dist/types/api-model/base.d.ts +0 -42
  310. package/dist/types/api-model/common.d.ts +0 -34
  311. package/dist/types/api-model/configuration.d.ts +0 -98
  312. package/dist/types/api-model/index.d.ts +0 -14
  313. package/dist/types/api-model/models/address-input.d.ts +0 -60
  314. package/dist/types/api-model/models/address.d.ts +0 -60
  315. package/dist/types/api-model/models/all-owners-constraint.d.ts +0 -18
  316. package/dist/types/api-model/models/appointment-slot-time.d.ts +0 -24
  317. package/dist/types/api-model/models/appointment-slot.d.ts +0 -22
  318. package/dist/types/api-model/models/box-content-information-source.d.ts +0 -20
  319. package/dist/types/api-model/models/box-input.d.ts +0 -31
  320. package/dist/types/api-model/models/box-requirements.d.ts +0 -18
  321. package/dist/types/api-model/models/box-update-input.d.ts +0 -35
  322. package/dist/types/api-model/models/box.d.ts +0 -53
  323. package/dist/types/api-model/models/cancel-inbound-plan-response.d.ts +0 -20
  324. package/dist/types/api-model/models/cancel-self-ship-appointment-request.d.ts +0 -18
  325. package/dist/types/api-model/models/cancel-self-ship-appointment-response.d.ts +0 -20
  326. package/dist/types/api-model/models/carrier-appointment.d.ts +0 -24
  327. package/dist/types/api-model/models/carrier.d.ts +0 -24
  328. package/dist/types/api-model/models/compliance-detail.d.ts +0 -30
  329. package/dist/types/api-model/models/confirm-delivery-window-options-response.d.ts +0 -20
  330. package/dist/types/api-model/models/confirm-packing-option-response.d.ts +0 -20
  331. package/dist/types/api-model/models/confirm-placement-option-response.d.ts +0 -20
  332. package/dist/types/api-model/models/confirm-shipment-content-update-preview-response.d.ts +0 -20
  333. package/dist/types/api-model/models/confirm-transportation-options-request.d.ts +0 -21
  334. package/dist/types/api-model/models/confirm-transportation-options-response.d.ts +0 -20
  335. package/dist/types/api-model/models/contact-information.d.ts +0 -28
  336. package/dist/types/api-model/models/content-update-preview.d.ts +0 -28
  337. package/dist/types/api-model/models/create-inbound-plan-request.d.ts +0 -31
  338. package/dist/types/api-model/models/create-inbound-plan-response.d.ts +0 -24
  339. package/dist/types/api-model/models/create-marketplace-item-labels-request.d.ts +0 -41
  340. package/dist/types/api-model/models/create-marketplace-item-labels-response.d.ts +0 -21
  341. package/dist/types/api-model/models/currency.d.ts +0 -24
  342. package/dist/types/api-model/models/custom-placement-input.d.ts +0 -25
  343. package/dist/types/api-model/models/dates.d.ts +0 -18
  344. package/dist/types/api-model/models/delivery-window-option.d.ts +0 -36
  345. package/dist/types/api-model/models/dimensions.d.ts +0 -30
  346. package/dist/types/api-model/models/document-download.d.ts +0 -28
  347. package/dist/types/api-model/models/error-list.d.ts +0 -20
  348. package/dist/types/api-model/models/freight-information.d.ts +0 -22
  349. package/dist/types/api-model/models/generate-delivery-window-options-response.d.ts +0 -20
  350. package/dist/types/api-model/models/generate-packing-options-response.d.ts +0 -20
  351. package/dist/types/api-model/models/generate-placement-options-request.d.ts +0 -21
  352. package/dist/types/api-model/models/generate-placement-options-response.d.ts +0 -20
  353. package/dist/types/api-model/models/generate-self-ship-appointment-slots-request.d.ts +0 -24
  354. package/dist/types/api-model/models/generate-self-ship-appointment-slots-response.d.ts +0 -20
  355. package/dist/types/api-model/models/generate-shipment-content-update-previews-request.d.ts +0 -26
  356. package/dist/types/api-model/models/generate-shipment-content-update-previews-response.d.ts +0 -20
  357. package/dist/types/api-model/models/generate-transportation-options-request.d.ts +0 -25
  358. package/dist/types/api-model/models/generate-transportation-options-response.d.ts +0 -20
  359. package/dist/types/api-model/models/get-delivery-challan-document-response.d.ts +0 -18
  360. package/dist/types/api-model/models/get-self-ship-appointment-slots-response.d.ts +0 -20
  361. package/dist/types/api-model/models/inbound-operation-status.d.ts +0 -31
  362. package/dist/types/api-model/models/inbound-plan-summary.d.ts +0 -42
  363. package/dist/types/api-model/models/inbound-plan.d.ts +0 -57
  364. package/dist/types/api-model/models/incentive.d.ts +0 -30
  365. package/dist/types/api-model/models/index.d.ts +0 -140
  366. package/dist/types/api-model/models/item-input.d.ts +0 -36
  367. package/dist/types/api-model/models/item-label-page-type.d.ts +0 -28
  368. package/dist/types/api-model/models/item.d.ts +0 -49
  369. package/dist/types/api-model/models/label-owner.d.ts +0 -20
  370. package/dist/types/api-model/models/label-print-type.d.ts +0 -19
  371. package/dist/types/api-model/models/list-delivery-window-options-response.d.ts +0 -23
  372. package/dist/types/api-model/models/list-inbound-plan-boxes-response.d.ts +0 -23
  373. package/dist/types/api-model/models/list-inbound-plan-items-response.d.ts +0 -23
  374. package/dist/types/api-model/models/list-inbound-plan-pallets-response.d.ts +0 -23
  375. package/dist/types/api-model/models/list-inbound-plans-response.d.ts +0 -23
  376. package/dist/types/api-model/models/list-item-compliance-details-response.d.ts +0 -21
  377. package/dist/types/api-model/models/list-packing-group-boxes-response.d.ts +0 -23
  378. package/dist/types/api-model/models/list-packing-group-items-response.d.ts +0 -23
  379. package/dist/types/api-model/models/list-packing-options-response.d.ts +0 -23
  380. package/dist/types/api-model/models/list-placement-options-response.d.ts +0 -23
  381. package/dist/types/api-model/models/list-prep-details-response.d.ts +0 -21
  382. package/dist/types/api-model/models/list-shipment-boxes-response.d.ts +0 -23
  383. package/dist/types/api-model/models/list-shipment-content-update-previews-response.d.ts +0 -23
  384. package/dist/types/api-model/models/list-shipment-items-response.d.ts +0 -23
  385. package/dist/types/api-model/models/list-shipment-pallets-response.d.ts +0 -23
  386. package/dist/types/api-model/models/list-transportation-options-response.d.ts +0 -23
  387. package/dist/types/api-model/models/ltl-tracking-detail-input.d.ts +0 -24
  388. package/dist/types/api-model/models/ltl-tracking-detail.d.ts +0 -24
  389. package/dist/types/api-model/models/model-error.d.ts +0 -28
  390. package/dist/types/api-model/models/msku-prep-detail-input.d.ts +0 -27
  391. package/dist/types/api-model/models/msku-prep-detail.d.ts +0 -32
  392. package/dist/types/api-model/models/msku-quantity.d.ts +0 -24
  393. package/dist/types/api-model/models/operation-problem.d.ts +0 -32
  394. package/dist/types/api-model/models/operation-status.d.ts +0 -20
  395. package/dist/types/api-model/models/owner-constraint.d.ts +0 -20
  396. package/dist/types/api-model/models/package-grouping-input.d.ts +0 -29
  397. package/dist/types/api-model/models/packing-configuration.d.ts +0 -28
  398. package/dist/types/api-model/models/packing-option-summary.d.ts +0 -24
  399. package/dist/types/api-model/models/packing-option.d.ts +0 -51
  400. package/dist/types/api-model/models/pagination.d.ts +0 -20
  401. package/dist/types/api-model/models/pallet-input.d.ts +0 -26
  402. package/dist/types/api-model/models/pallet.d.ts +0 -30
  403. package/dist/types/api-model/models/placement-option-summary.d.ts +0 -24
  404. package/dist/types/api-model/models/placement-option.d.ts +0 -41
  405. package/dist/types/api-model/models/prep-category.d.ts +0 -31
  406. package/dist/types/api-model/models/prep-instruction.d.ts +0 -26
  407. package/dist/types/api-model/models/prep-owner.d.ts +0 -20
  408. package/dist/types/api-model/models/prep-type.d.ts +0 -33
  409. package/dist/types/api-model/models/quote.d.ts +0 -26
  410. package/dist/types/api-model/models/reason-comment.d.ts +0 -26
  411. package/dist/types/api-model/models/region.d.ts +0 -28
  412. package/dist/types/api-model/models/requested-updates.d.ts +0 -26
  413. package/dist/types/api-model/models/schedule-self-ship-appointment-request.d.ts +0 -18
  414. package/dist/types/api-model/models/schedule-self-ship-appointment-response.d.ts +0 -18
  415. package/dist/types/api-model/models/selected-delivery-window.d.ts +0 -36
  416. package/dist/types/api-model/models/self-ship-appointment-details.d.ts +0 -26
  417. package/dist/types/api-model/models/self-ship-appointment-slots-availability.d.ts +0 -25
  418. package/dist/types/api-model/models/set-packing-information-request.d.ts +0 -21
  419. package/dist/types/api-model/models/set-packing-information-response.d.ts +0 -20
  420. package/dist/types/api-model/models/set-prep-details-request.d.ts +0 -25
  421. package/dist/types/api-model/models/set-prep-details-response.d.ts +0 -20
  422. package/dist/types/api-model/models/shipment-destination.d.ts +0 -26
  423. package/dist/types/api-model/models/shipment-source.d.ts +0 -22
  424. package/dist/types/api-model/models/shipment-summary.d.ts +0 -24
  425. package/dist/types/api-model/models/shipment-transportation-configuration.d.ts +0 -31
  426. package/dist/types/api-model/models/shipment.d.ts +0 -63
  427. package/dist/types/api-model/models/shipping-configuration.d.ts +0 -24
  428. package/dist/types/api-model/models/shipping-requirements.d.ts +0 -24
  429. package/dist/types/api-model/models/spd-tracking-detail-input.d.ts +0 -21
  430. package/dist/types/api-model/models/spd-tracking-detail.d.ts +0 -21
  431. package/dist/types/api-model/models/spd-tracking-item-input.d.ts +0 -24
  432. package/dist/types/api-model/models/spd-tracking-item.d.ts +0 -28
  433. package/dist/types/api-model/models/stackability.d.ts +0 -19
  434. package/dist/types/api-model/models/tax-details.d.ts +0 -27
  435. package/dist/types/api-model/models/tax-rate.d.ts +0 -28
  436. package/dist/types/api-model/models/tracking-details-input.d.ts +0 -20
  437. package/dist/types/api-model/models/tracking-details.d.ts +0 -20
  438. package/dist/types/api-model/models/transportation-option.d.ts +0 -42
  439. package/dist/types/api-model/models/transportation-selection.d.ts +0 -26
  440. package/dist/types/api-model/models/unit-of-measurement.d.ts +0 -19
  441. package/dist/types/api-model/models/unit-of-weight.d.ts +0 -19
  442. package/dist/types/api-model/models/update-inbound-plan-name-request.d.ts +0 -20
  443. package/dist/types/api-model/models/update-item-compliance-details-request.d.ts +0 -22
  444. package/dist/types/api-model/models/update-item-compliance-details-response.d.ts +0 -20
  445. package/dist/types/api-model/models/update-shipment-name-request.d.ts +0 -20
  446. package/dist/types/api-model/models/update-shipment-source-address-request.d.ts +0 -18
  447. package/dist/types/api-model/models/update-shipment-source-address-response.d.ts +0 -20
  448. package/dist/types/api-model/models/update-shipment-tracking-details-request.d.ts +0 -18
  449. package/dist/types/api-model/models/update-shipment-tracking-details-response.d.ts +0 -20
  450. package/dist/types/api-model/models/weight-range.d.ts +0 -26
  451. package/dist/types/api-model/models/weight.d.ts +0 -22
  452. package/dist/types/api-model/models/window-input.d.ts +0 -20
  453. package/dist/types/api-model/models/window.d.ts +0 -28
  454. package/dist/types/client.d.ts +0 -6
  455. package/dist/types/index.d.ts +0 -3
@@ -1,2231 +0,0 @@
1
- /**
2
- * The Selling Partner API for FBA inbound operations.
3
- * 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.
4
- *
5
- * The version of the OpenAPI document: 2024-03-20
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from '../configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import globalAxios from 'axios';
15
- import { type RequestArgs, BaseAPI } from '../base';
16
- import type { CancelInboundPlanResponse } from '../models';
17
- import type { CancelSelfShipAppointmentRequest } from '../models';
18
- import type { CancelSelfShipAppointmentResponse } from '../models';
19
- import type { ConfirmDeliveryWindowOptionsResponse } from '../models';
20
- import type { ConfirmPackingOptionResponse } from '../models';
21
- import type { ConfirmPlacementOptionResponse } from '../models';
22
- import type { ConfirmShipmentContentUpdatePreviewResponse } from '../models';
23
- import type { ConfirmTransportationOptionsRequest } from '../models';
24
- import type { ConfirmTransportationOptionsResponse } from '../models';
25
- import type { ContentUpdatePreview } from '../models';
26
- import type { CreateInboundPlanRequest } from '../models';
27
- import type { CreateInboundPlanResponse } from '../models';
28
- import type { CreateMarketplaceItemLabelsRequest } from '../models';
29
- import type { CreateMarketplaceItemLabelsResponse } from '../models';
30
- import type { GenerateDeliveryWindowOptionsResponse } from '../models';
31
- import type { GeneratePackingOptionsResponse } from '../models';
32
- import type { GeneratePlacementOptionsRequest } from '../models';
33
- import type { GeneratePlacementOptionsResponse } from '../models';
34
- import type { GenerateSelfShipAppointmentSlotsRequest } from '../models';
35
- import type { GenerateSelfShipAppointmentSlotsResponse } from '../models';
36
- import type { GenerateShipmentContentUpdatePreviewsRequest } from '../models';
37
- import type { GenerateShipmentContentUpdatePreviewsResponse } from '../models';
38
- import type { GenerateTransportationOptionsRequest } from '../models';
39
- import type { GenerateTransportationOptionsResponse } from '../models';
40
- import type { GetDeliveryChallanDocumentResponse } from '../models';
41
- import type { GetSelfShipAppointmentSlotsResponse } from '../models';
42
- import type { InboundOperationStatus } from '../models';
43
- import type { InboundPlan } from '../models';
44
- import type { ListDeliveryWindowOptionsResponse } from '../models';
45
- import type { ListInboundPlanBoxesResponse } from '../models';
46
- import type { ListInboundPlanItemsResponse } from '../models';
47
- import type { ListInboundPlanPalletsResponse } from '../models';
48
- import type { ListInboundPlansResponse } from '../models';
49
- import type { ListItemComplianceDetailsResponse } from '../models';
50
- import type { ListPackingGroupBoxesResponse } from '../models';
51
- import type { ListPackingGroupItemsResponse } from '../models';
52
- import type { ListPackingOptionsResponse } from '../models';
53
- import type { ListPlacementOptionsResponse } from '../models';
54
- import type { ListPrepDetailsResponse } from '../models';
55
- import type { ListShipmentBoxesResponse } from '../models';
56
- import type { ListShipmentContentUpdatePreviewsResponse } from '../models';
57
- import type { ListShipmentItemsResponse } from '../models';
58
- import type { ListShipmentPalletsResponse } from '../models';
59
- import type { ListTransportationOptionsResponse } from '../models';
60
- import type { ScheduleSelfShipAppointmentRequest } from '../models';
61
- import type { ScheduleSelfShipAppointmentResponse } from '../models';
62
- import type { SetPackingInformationRequest } from '../models';
63
- import type { SetPackingInformationResponse } from '../models';
64
- import type { SetPrepDetailsRequest } from '../models';
65
- import type { SetPrepDetailsResponse } from '../models';
66
- import type { Shipment } from '../models';
67
- import type { UpdateInboundPlanNameRequest } from '../models';
68
- import type { UpdateItemComplianceDetailsRequest } from '../models';
69
- import type { UpdateItemComplianceDetailsResponse } from '../models';
70
- import type { UpdateShipmentNameRequest } from '../models';
71
- import type { UpdateShipmentSourceAddressRequest } from '../models';
72
- import type { UpdateShipmentSourceAddressResponse } from '../models';
73
- import type { UpdateShipmentTrackingDetailsRequest } from '../models';
74
- import type { UpdateShipmentTrackingDetailsResponse } from '../models';
75
- /**
76
- * FulfillmentInboundApi - axios parameter creator
77
- */
78
- export declare const FulfillmentInboundApiAxiosParamCreator: (configuration?: Configuration) => {
79
- /**
80
- * 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.
81
- * @param {string} inboundPlanId Identifier of an inbound plan.
82
- * @param {*} [options] Override http request option.
83
- * @throws {RequiredError}
84
- */
85
- cancelInboundPlan: (inboundPlanId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
86
- /**
87
- * Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
88
- * @param {string} inboundPlanId Identifier of an inbound plan.
89
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
90
- * @param {CancelSelfShipAppointmentRequest} body The body of the request to &#x60;cancelSelfShipAppointment&#x60;.
91
- * @param {*} [options] Override http request option.
92
- * @throws {RequiredError}
93
- */
94
- cancelSelfShipAppointment: (inboundPlanId: string, shipmentId: string, body: CancelSelfShipAppointmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
95
- /**
96
- * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation.
97
- * @param {string} inboundPlanId Identifier of an inbound plan.
98
- * @param {string} shipmentId The shipment to confirm the delivery window option for.
99
- * @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed.
100
- * @param {*} [options] Override http request option.
101
- * @throws {RequiredError}
102
- */
103
- confirmDeliveryWindowOptions: (inboundPlanId: string, shipmentId: string, deliveryWindowOptionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
104
- /**
105
- * Confirms the packing option for an inbound plan.
106
- * @param {string} inboundPlanId Identifier of an inbound plan.
107
- * @param {string} packingOptionId Identifier of a packing option.
108
- * @param {*} [options] Override http request option.
109
- * @throws {RequiredError}
110
- */
111
- confirmPackingOption: (inboundPlanId: string, packingOptionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
112
- /**
113
- * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
114
- * @param {string} inboundPlanId Identifier of an inbound plan.
115
- * @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
116
- * @param {*} [options] Override http request option.
117
- * @throws {RequiredError}
118
- */
119
- confirmPlacementOption: (inboundPlanId: string, placementOptionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
120
- /**
121
- * Confirm a shipment content update preview and accept the changes in transportation cost.
122
- * @param {string} inboundPlanId Identifier of an inbound plan.
123
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
124
- * @param {string} contentUpdatePreviewId Identifier of a content update preview.
125
- * @param {*} [options] Override http request option.
126
- * @throws {RequiredError}
127
- */
128
- confirmShipmentContentUpdatePreview: (inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
129
- /**
130
- * 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.
131
- * @param {string} inboundPlanId Identifier of an inbound plan.
132
- * @param {ConfirmTransportationOptionsRequest} body The body of the request to &#x60;confirmTransportationOptions&#x60;.
133
- * @param {*} [options] Override http request option.
134
- * @throws {RequiredError}
135
- */
136
- confirmTransportationOptions: (inboundPlanId: string, body: ConfirmTransportationOptionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
137
- /**
138
- * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network.
139
- * @param {CreateInboundPlanRequest} body The body of the request to &#x60;createInboundPlan&#x60;.
140
- * @param {*} [options] Override http request option.
141
- * @throws {RequiredError}
142
- */
143
- createInboundPlan: (body: CreateInboundPlanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
144
- /**
145
- * For a given marketplace - creates labels for a list of MSKUs.
146
- * @param {CreateMarketplaceItemLabelsRequest} body The body of the request to &#x60;createMarketplaceItemLabels&#x60;.
147
- * @param {*} [options] Override http request option.
148
- * @throws {RequiredError}
149
- */
150
- createMarketplaceItemLabels: (body: CreateMarketplaceItemLabelsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
151
- /**
152
- * Generates available delivery window options for a given shipment.
153
- * @param {string} inboundPlanId Identifier of an inbound plan.
154
- * @param {string} shipmentId The shipment to generate delivery window options for.
155
- * @param {*} [options] Override http request option.
156
- * @throws {RequiredError}
157
- */
158
- generateDeliveryWindowOptions: (inboundPlanId: string, shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
159
- /**
160
- * Generates available packing options for the inbound plan.
161
- * @param {string} inboundPlanId Identifier of an inbound plan.
162
- * @param {*} [options] Override http request option.
163
- * @throws {RequiredError}
164
- */
165
- generatePackingOptions: (inboundPlanId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
166
- /**
167
- * Generates placement options for the inbound plan.
168
- * @param {string} inboundPlanId Identifier of an inbound plan.
169
- * @param {GeneratePlacementOptionsRequest} body The body of the request to &#x60;generatePlacementOptions&#x60;.
170
- * @param {*} [options] Override http request option.
171
- * @throws {RequiredError}
172
- */
173
- generatePlacementOptions: (inboundPlanId: string, body: GeneratePlacementOptionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
174
- /**
175
- * Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
176
- * @param {string} inboundPlanId Identifier of an inbound plan.
177
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
178
- * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to &#x60;generateSelfShipAppointmentSlots&#x60;.
179
- * @param {*} [options] Override http request option.
180
- * @throws {RequiredError}
181
- */
182
- generateSelfShipAppointmentSlots: (inboundPlanId: string, shipmentId: string, body: GenerateSelfShipAppointmentSlotsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
183
- /**
184
- * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.
185
- * @param {string} inboundPlanId Identifier of an inbound plan.
186
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
187
- * @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to &#x60;generateShipmentContentUpdatePreviews&#x60;.
188
- * @param {*} [options] Override http request option.
189
- * @throws {RequiredError}
190
- */
191
- generateShipmentContentUpdatePreviews: (inboundPlanId: string, shipmentId: string, body: GenerateShipmentContentUpdatePreviewsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
192
- /**
193
- * Generates available transportation options for a given placement option.
194
- * @param {string} inboundPlanId Identifier of an inbound plan.
195
- * @param {GenerateTransportationOptionsRequest} body The body of the request to &#x60;generateTransportationOptions&#x60;.
196
- * @param {*} [options] Override http request option.
197
- * @throws {RequiredError}
198
- */
199
- generateTransportationOptions: (inboundPlanId: string, body: GenerateTransportationOptionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
200
- /**
201
- * Provide delivery challan document for PCP transportation in IN marketplace.
202
- * @param {string} inboundPlanId Identifier of an inbound plan.
203
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
204
- * @param {*} [options] Override http request option.
205
- * @throws {RequiredError}
206
- */
207
- getDeliveryChallanDocument: (inboundPlanId: string, shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
208
- /**
209
- * Gets the status of the processing of an asynchronous API call.
210
- * @param {string} operationId Identifier of an asynchronous operation.
211
- * @param {*} [options] Override http request option.
212
- * @throws {RequiredError}
213
- */
214
- getInboundOperationStatus: (operationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
215
- /**
216
- * Fetches the top level information about an inbound plan.
217
- * @param {string} inboundPlanId Identifier of an inbound plan.
218
- * @param {*} [options] Override http request option.
219
- * @throws {RequiredError}
220
- */
221
- getInboundPlan: (inboundPlanId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
222
- /**
223
- * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
224
- * @param {string} inboundPlanId Identifier of an inbound plan.
225
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
226
- * @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
227
- * @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.
228
- * @param {*} [options] Override http request option.
229
- * @throws {RequiredError}
230
- */
231
- getSelfShipAppointmentSlots: (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
232
- /**
233
- * 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.
234
- * @param {string} inboundPlanId Identifier of an inbound plan.
235
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
236
- * @param {*} [options] Override http request option.
237
- * @throws {RequiredError}
238
- */
239
- getShipment: (inboundPlanId: string, shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
240
- /**
241
- * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
242
- * @param {string} inboundPlanId Identifier of an inbound plan.
243
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
244
- * @param {string} contentUpdatePreviewId Identifier of a content update preview.
245
- * @param {*} [options] Override http request option.
246
- * @throws {RequiredError}
247
- */
248
- getShipmentContentUpdatePreview: (inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
249
- /**
250
- * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available.
251
- * @param {string} inboundPlanId Identifier of an inbound plan.
252
- * @param {string} shipmentId The shipment to get delivery window options for.
253
- * @param {number} [pageSize] The number of delivery window options to return in the response matching the given query.
254
- * @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.
255
- * @param {*} [options] Override http request option.
256
- * @throws {RequiredError}
257
- */
258
- listDeliveryWindowOptions: (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
259
- /**
260
- * Provides a paginated list of box packages in an inbound plan.
261
- * @param {string} inboundPlanId Identifier of an inbound plan.
262
- * @param {number} [pageSize] The number of boxes to return in the response matching the given query.
263
- * @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.
264
- * @param {*} [options] Override http request option.
265
- * @throws {RequiredError}
266
- */
267
- listInboundPlanBoxes: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
268
- /**
269
- * Provides a paginated list of item packages in an inbound plan.
270
- * @param {string} inboundPlanId Identifier of an inbound plan.
271
- * @param {number} [pageSize] The number of items to return in the response matching the given query.
272
- * @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.
273
- * @param {*} [options] Override http request option.
274
- * @throws {RequiredError}
275
- */
276
- listInboundPlanItems: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
277
- /**
278
- * 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.
279
- * @param {string} inboundPlanId Identifier of an inbound plan.
280
- * @param {number} [pageSize] The number of pallets to return in the response matching the given query.
281
- * @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.
282
- * @param {*} [options] Override http request option.
283
- * @throws {RequiredError}
284
- */
285
- listInboundPlanPallets: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
286
- /**
287
- * Provides a list of inbound plans with minimal information.
288
- * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query.
289
- * @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.
290
- * @param {ListInboundPlansStatusEnum} [status] The status of an inbound plan.
291
- * @param {ListInboundPlansSortByEnum} [sortBy] Sort by field.
292
- * @param {ListInboundPlansSortOrderEnum} [sortOrder] The sort order.
293
- * @param {*} [options] Override http request option.
294
- * @throws {RequiredError}
295
- */
296
- listInboundPlans: (pageSize?: number, paginationToken?: string, status?: ListInboundPlansStatusEnum, sortBy?: ListInboundPlansSortByEnum, sortOrder?: ListInboundPlansSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
297
- /**
298
- * List the inbound compliance details for MSKUs in a given marketplace. **Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). The following characters must be double percent encoded: - `%` - `+` - `,` **Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
299
- * @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
300
- * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
301
- * @param {*} [options] Override http request option.
302
- * @throws {RequiredError}
303
- */
304
- listItemComplianceDetails: (mskus: Array<string>, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
305
- /**
306
- * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.
307
- * @param {string} inboundPlanId Identifier of an inbound plan.
308
- * @param {string} packingGroupId Identifier of a packing group.
309
- * @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query.
310
- * @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.
311
- * @param {*} [options] Override http request option.
312
- * @throws {RequiredError}
313
- */
314
- listPackingGroupBoxes: (inboundPlanId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
315
- /**
316
- * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.
317
- * @param {string} inboundPlanId Identifier of an inbound plan.
318
- * @param {string} packingGroupId Identifier of a packing group.
319
- * @param {number} [pageSize] The number of packing group items to return in the response matching the given query.
320
- * @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.
321
- * @param {*} [options] Override http request option.
322
- * @throws {RequiredError}
323
- */
324
- listPackingGroupItems: (inboundPlanId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
325
- /**
326
- * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.
327
- * @param {string} inboundPlanId Identifier of an inbound plan.
328
- * @param {number} [pageSize] The number of packing options to return in the response matching the given query.
329
- * @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.
330
- * @param {*} [options] Override http request option.
331
- * @throws {RequiredError}
332
- */
333
- listPackingOptions: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
334
- /**
335
- * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.
336
- * @param {string} inboundPlanId Identifier of an inbound plan.
337
- * @param {number} [pageSize] The number of placement options to return in the response matching the given query.
338
- * @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.
339
- * @param {*} [options] Override http request option.
340
- * @throws {RequiredError}
341
- */
342
- listPlacementOptions: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
343
- /**
344
- * Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
345
- * @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
346
- * @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
347
- * @param {*} [options] Override http request option.
348
- * @throws {RequiredError}
349
- */
350
- listPrepDetails: (marketplaceId: string, mskus: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
351
- /**
352
- * Provides a paginated list of box packages in a shipment.
353
- * @param {string} inboundPlanId Identifier of an inbound plan.
354
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
355
- * @param {number} [pageSize] The number of boxes to return in the response matching the given query.
356
- * @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.
357
- * @param {*} [options] Override http request option.
358
- * @throws {RequiredError}
359
- */
360
- listShipmentBoxes: (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
361
- /**
362
- * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
363
- * @param {string} inboundPlanId Identifier of an inbound plan.
364
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
365
- * @param {number} [pageSize] The number of content update previews to return.
366
- * @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.
367
- * @param {*} [options] Override http request option.
368
- * @throws {RequiredError}
369
- */
370
- listShipmentContentUpdatePreviews: (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
371
- /**
372
- * Provides a paginated list of item packages in a shipment.
373
- * @param {string} inboundPlanId Identifier of an inbound plan.
374
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
375
- * @param {number} [pageSize] The number of items to return in the response matching the given query.
376
- * @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.
377
- * @param {*} [options] Override http request option.
378
- * @throws {RequiredError}
379
- */
380
- listShipmentItems: (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
381
- /**
382
- * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
383
- * @param {string} inboundPlanId Identifier of an inbound plan.
384
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
385
- * @param {number} [pageSize] The number of pallets to return in the response matching the given query.
386
- * @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.
387
- * @param {*} [options] Override http request option.
388
- * @throws {RequiredError}
389
- */
390
- listShipmentPallets: (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
391
- /**
392
- * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available.
393
- * @param {string} inboundPlanId Identifier of an inbound plan.
394
- * @param {number} [pageSize] The number of transportation options to return in the response matching the given query.
395
- * @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.
396
- * @param {string} [placementOptionId] The placement option to get transportation options for. Either &#x60;placementOptionId&#x60; or &#x60;shipmentId&#x60; must be specified.
397
- * @param {string} [shipmentId] The shipment to get transportation options for. Either &#x60;placementOptionId&#x60; or &#x60;shipmentId&#x60; must be specified.
398
- * @param {*} [options] Override http request option.
399
- * @throws {RequiredError}
400
- */
401
- listTransportationOptions: (inboundPlanId: string, pageSize?: number, paginationToken?: string, placementOptionId?: string, shipmentId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
402
- /**
403
- * Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
404
- * @param {string} inboundPlanId Identifier of an inbound plan.
405
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
406
- * @param {string} slotId An identifier to a self-ship appointment slot.
407
- * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to &#x60;scheduleSelfShipAppointment&#x60;.
408
- * @param {*} [options] Override http request option.
409
- * @throws {RequiredError}
410
- */
411
- scheduleSelfShipAppointment: (inboundPlanId: string, shipmentId: string, slotId: string, body: ScheduleSelfShipAppointmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
412
- /**
413
- * 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.
414
- * @param {string} inboundPlanId Identifier of an inbound plan.
415
- * @param {SetPackingInformationRequest} body The body of the request to &#x60;setPackingInformation&#x60;.
416
- * @param {*} [options] Override http request option.
417
- * @throws {RequiredError}
418
- */
419
- setPackingInformation: (inboundPlanId: string, body: SetPackingInformationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
420
- /**
421
- * Set the preparation details for a list of MSKUs in a specified marketplace.
422
- * @param {SetPrepDetailsRequest} body The body of the request to &#x60;setPrepDetails&#x60;.
423
- * @param {*} [options] Override http request option.
424
- * @throws {RequiredError}
425
- */
426
- setPrepDetails: (body: SetPrepDetailsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
427
- /**
428
- * Updates the name of an existing inbound plan.
429
- * @param {string} inboundPlanId Identifier of an inbound plan.
430
- * @param {UpdateInboundPlanNameRequest} body The body of the request to &#x60;updateInboundPlanName&#x60;.
431
- * @param {*} [options] Override http request option.
432
- * @throws {RequiredError}
433
- */
434
- updateInboundPlanName: (inboundPlanId: string, body: UpdateInboundPlanNameRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
435
- /**
436
- * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.
437
- * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
438
- * @param {UpdateItemComplianceDetailsRequest} body The body of the request to &#x60;updateItemComplianceDetails&#x60;.
439
- * @param {*} [options] Override http request option.
440
- * @throws {RequiredError}
441
- */
442
- updateItemComplianceDetails: (marketplaceId: string, body: UpdateItemComplianceDetailsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
443
- /**
444
- * Updates the name of an existing shipment.
445
- * @param {string} inboundPlanId Identifier of an inbound plan.
446
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
447
- * @param {UpdateShipmentNameRequest} body The body of the request to &#x60;updateShipmentName&#x60;.
448
- * @param {*} [options] Override http request option.
449
- * @throws {RequiredError}
450
- */
451
- updateShipmentName: (inboundPlanId: string, shipmentId: string, body: UpdateShipmentNameRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
452
- /**
453
- * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.
454
- * @param {string} inboundPlanId Identifier of an inbound plan.
455
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
456
- * @param {UpdateShipmentSourceAddressRequest} body The body of the request to &#x60;updateShipmentSourceAddress&#x60;.
457
- * @param {*} [options] Override http request option.
458
- * @throws {RequiredError}
459
- */
460
- updateShipmentSourceAddress: (inboundPlanId: string, shipmentId: string, body: UpdateShipmentSourceAddressRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
461
- /**
462
- * Updates a shipment\'s tracking details.
463
- * @param {string} inboundPlanId Identifier of an inbound plan.
464
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
465
- * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to &#x60;updateShipmentTrackingDetails&#x60;.
466
- * @param {*} [options] Override http request option.
467
- * @throws {RequiredError}
468
- */
469
- updateShipmentTrackingDetails: (inboundPlanId: string, shipmentId: string, body: UpdateShipmentTrackingDetailsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
470
- };
471
- /**
472
- * FulfillmentInboundApi - functional programming interface
473
- */
474
- export declare const FulfillmentInboundApiFp: (configuration?: Configuration) => {
475
- /**
476
- * 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.
477
- * @param {string} inboundPlanId Identifier of an inbound plan.
478
- * @param {*} [options] Override http request option.
479
- * @throws {RequiredError}
480
- */
481
- cancelInboundPlan(inboundPlanId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelInboundPlanResponse>>;
482
- /**
483
- * Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
484
- * @param {string} inboundPlanId Identifier of an inbound plan.
485
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
486
- * @param {CancelSelfShipAppointmentRequest} body The body of the request to &#x60;cancelSelfShipAppointment&#x60;.
487
- * @param {*} [options] Override http request option.
488
- * @throws {RequiredError}
489
- */
490
- cancelSelfShipAppointment(inboundPlanId: string, shipmentId: string, body: CancelSelfShipAppointmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelSelfShipAppointmentResponse>>;
491
- /**
492
- * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation.
493
- * @param {string} inboundPlanId Identifier of an inbound plan.
494
- * @param {string} shipmentId The shipment to confirm the delivery window option for.
495
- * @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed.
496
- * @param {*} [options] Override http request option.
497
- * @throws {RequiredError}
498
- */
499
- confirmDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, deliveryWindowOptionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmDeliveryWindowOptionsResponse>>;
500
- /**
501
- * Confirms the packing option for an inbound plan.
502
- * @param {string} inboundPlanId Identifier of an inbound plan.
503
- * @param {string} packingOptionId Identifier of a packing option.
504
- * @param {*} [options] Override http request option.
505
- * @throws {RequiredError}
506
- */
507
- confirmPackingOption(inboundPlanId: string, packingOptionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmPackingOptionResponse>>;
508
- /**
509
- * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
510
- * @param {string} inboundPlanId Identifier of an inbound plan.
511
- * @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
512
- * @param {*} [options] Override http request option.
513
- * @throws {RequiredError}
514
- */
515
- confirmPlacementOption(inboundPlanId: string, placementOptionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmPlacementOptionResponse>>;
516
- /**
517
- * Confirm a shipment content update preview and accept the changes in transportation cost.
518
- * @param {string} inboundPlanId Identifier of an inbound plan.
519
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
520
- * @param {string} contentUpdatePreviewId Identifier of a content update preview.
521
- * @param {*} [options] Override http request option.
522
- * @throws {RequiredError}
523
- */
524
- confirmShipmentContentUpdatePreview(inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmShipmentContentUpdatePreviewResponse>>;
525
- /**
526
- * 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.
527
- * @param {string} inboundPlanId Identifier of an inbound plan.
528
- * @param {ConfirmTransportationOptionsRequest} body The body of the request to &#x60;confirmTransportationOptions&#x60;.
529
- * @param {*} [options] Override http request option.
530
- * @throws {RequiredError}
531
- */
532
- confirmTransportationOptions(inboundPlanId: string, body: ConfirmTransportationOptionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmTransportationOptionsResponse>>;
533
- /**
534
- * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network.
535
- * @param {CreateInboundPlanRequest} body The body of the request to &#x60;createInboundPlan&#x60;.
536
- * @param {*} [options] Override http request option.
537
- * @throws {RequiredError}
538
- */
539
- createInboundPlan(body: CreateInboundPlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInboundPlanResponse>>;
540
- /**
541
- * For a given marketplace - creates labels for a list of MSKUs.
542
- * @param {CreateMarketplaceItemLabelsRequest} body The body of the request to &#x60;createMarketplaceItemLabels&#x60;.
543
- * @param {*} [options] Override http request option.
544
- * @throws {RequiredError}
545
- */
546
- createMarketplaceItemLabels(body: CreateMarketplaceItemLabelsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMarketplaceItemLabelsResponse>>;
547
- /**
548
- * Generates available delivery window options for a given shipment.
549
- * @param {string} inboundPlanId Identifier of an inbound plan.
550
- * @param {string} shipmentId The shipment to generate delivery window options for.
551
- * @param {*} [options] Override http request option.
552
- * @throws {RequiredError}
553
- */
554
- generateDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateDeliveryWindowOptionsResponse>>;
555
- /**
556
- * Generates available packing options for the inbound plan.
557
- * @param {string} inboundPlanId Identifier of an inbound plan.
558
- * @param {*} [options] Override http request option.
559
- * @throws {RequiredError}
560
- */
561
- generatePackingOptions(inboundPlanId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneratePackingOptionsResponse>>;
562
- /**
563
- * Generates placement options for the inbound plan.
564
- * @param {string} inboundPlanId Identifier of an inbound plan.
565
- * @param {GeneratePlacementOptionsRequest} body The body of the request to &#x60;generatePlacementOptions&#x60;.
566
- * @param {*} [options] Override http request option.
567
- * @throws {RequiredError}
568
- */
569
- generatePlacementOptions(inboundPlanId: string, body: GeneratePlacementOptionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneratePlacementOptionsResponse>>;
570
- /**
571
- * Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
572
- * @param {string} inboundPlanId Identifier of an inbound plan.
573
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
574
- * @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to &#x60;generateSelfShipAppointmentSlots&#x60;.
575
- * @param {*} [options] Override http request option.
576
- * @throws {RequiredError}
577
- */
578
- generateSelfShipAppointmentSlots(inboundPlanId: string, shipmentId: string, body: GenerateSelfShipAppointmentSlotsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>>;
579
- /**
580
- * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.
581
- * @param {string} inboundPlanId Identifier of an inbound plan.
582
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
583
- * @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to &#x60;generateShipmentContentUpdatePreviews&#x60;.
584
- * @param {*} [options] Override http request option.
585
- * @throws {RequiredError}
586
- */
587
- generateShipmentContentUpdatePreviews(inboundPlanId: string, shipmentId: string, body: GenerateShipmentContentUpdatePreviewsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateShipmentContentUpdatePreviewsResponse>>;
588
- /**
589
- * Generates available transportation options for a given placement option.
590
- * @param {string} inboundPlanId Identifier of an inbound plan.
591
- * @param {GenerateTransportationOptionsRequest} body The body of the request to &#x60;generateTransportationOptions&#x60;.
592
- * @param {*} [options] Override http request option.
593
- * @throws {RequiredError}
594
- */
595
- generateTransportationOptions(inboundPlanId: string, body: GenerateTransportationOptionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateTransportationOptionsResponse>>;
596
- /**
597
- * Provide delivery challan document for PCP transportation in IN marketplace.
598
- * @param {string} inboundPlanId Identifier of an inbound plan.
599
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
600
- * @param {*} [options] Override http request option.
601
- * @throws {RequiredError}
602
- */
603
- getDeliveryChallanDocument(inboundPlanId: string, shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDeliveryChallanDocumentResponse>>;
604
- /**
605
- * Gets the status of the processing of an asynchronous API call.
606
- * @param {string} operationId Identifier of an asynchronous operation.
607
- * @param {*} [options] Override http request option.
608
- * @throws {RequiredError}
609
- */
610
- getInboundOperationStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundOperationStatus>>;
611
- /**
612
- * Fetches the top level information about an inbound plan.
613
- * @param {string} inboundPlanId Identifier of an inbound plan.
614
- * @param {*} [options] Override http request option.
615
- * @throws {RequiredError}
616
- */
617
- getInboundPlan(inboundPlanId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundPlan>>;
618
- /**
619
- * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
620
- * @param {string} inboundPlanId Identifier of an inbound plan.
621
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
622
- * @param {number} [pageSize] The number of self ship appointment slots 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 &#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.
624
- * @param {*} [options] Override http request option.
625
- * @throws {RequiredError}
626
- */
627
- getSelfShipAppointmentSlots(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSelfShipAppointmentSlotsResponse>>;
628
- /**
629
- * 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.
630
- * @param {string} inboundPlanId Identifier of an inbound plan.
631
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
632
- * @param {*} [options] Override http request option.
633
- * @throws {RequiredError}
634
- */
635
- getShipment(inboundPlanId: string, shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>>;
636
- /**
637
- * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
638
- * @param {string} inboundPlanId Identifier of an inbound plan.
639
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
640
- * @param {string} contentUpdatePreviewId Identifier of a content update preview.
641
- * @param {*} [options] Override http request option.
642
- * @throws {RequiredError}
643
- */
644
- getShipmentContentUpdatePreview(inboundPlanId: string, shipmentId: string, contentUpdatePreviewId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContentUpdatePreview>>;
645
- /**
646
- * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available.
647
- * @param {string} inboundPlanId Identifier of an inbound plan.
648
- * @param {string} shipmentId The shipment to get delivery window options for.
649
- * @param {number} [pageSize] The number of delivery window options to return in the response matching the given query.
650
- * @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.
651
- * @param {*} [options] Override http request option.
652
- * @throws {RequiredError}
653
- */
654
- listDeliveryWindowOptions(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDeliveryWindowOptionsResponse>>;
655
- /**
656
- * Provides a paginated list of box packages in an inbound plan.
657
- * @param {string} inboundPlanId Identifier of an inbound plan.
658
- * @param {number} [pageSize] The number of boxes to return in the response matching the given query.
659
- * @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.
660
- * @param {*} [options] Override http request option.
661
- * @throws {RequiredError}
662
- */
663
- listInboundPlanBoxes(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInboundPlanBoxesResponse>>;
664
- /**
665
- * Provides a paginated list of item packages in an inbound plan.
666
- * @param {string} inboundPlanId Identifier of an inbound plan.
667
- * @param {number} [pageSize] The number of items to return in the response matching the given query.
668
- * @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.
669
- * @param {*} [options] Override http request option.
670
- * @throws {RequiredError}
671
- */
672
- listInboundPlanItems(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInboundPlanItemsResponse>>;
673
- /**
674
- * 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.
675
- * @param {string} inboundPlanId Identifier of an inbound plan.
676
- * @param {number} [pageSize] The number of pallets to return in the response matching the given query.
677
- * @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.
678
- * @param {*} [options] Override http request option.
679
- * @throws {RequiredError}
680
- */
681
- listInboundPlanPallets(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInboundPlanPalletsResponse>>;
682
- /**
683
- * Provides a list of inbound plans with minimal information.
684
- * @param {number} [pageSize] The number of inbound plans to return in the response matching the given query.
685
- * @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.
686
- * @param {ListInboundPlansStatusEnum} [status] The status of an inbound plan.
687
- * @param {ListInboundPlansSortByEnum} [sortBy] Sort by field.
688
- * @param {ListInboundPlansSortOrderEnum} [sortOrder] The sort order.
689
- * @param {*} [options] Override http request option.
690
- * @throws {RequiredError}
691
- */
692
- listInboundPlans(pageSize?: number, paginationToken?: string, status?: ListInboundPlansStatusEnum, sortBy?: ListInboundPlansSortByEnum, sortOrder?: ListInboundPlansSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInboundPlansResponse>>;
693
- /**
694
- * List the inbound compliance details for MSKUs in a given marketplace. **Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). The following characters must be double percent encoded: - `%` - `+` - `,` **Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
695
- * @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
696
- * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
697
- * @param {*} [options] Override http request option.
698
- * @throws {RequiredError}
699
- */
700
- listItemComplianceDetails(mskus: Array<string>, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListItemComplianceDetailsResponse>>;
701
- /**
702
- * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.
703
- * @param {string} inboundPlanId Identifier of an inbound plan.
704
- * @param {string} packingGroupId Identifier of a packing group.
705
- * @param {number} [pageSize] The number of packing group boxes 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
- listPackingGroupBoxes(inboundPlanId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPackingGroupBoxesResponse>>;
711
- /**
712
- * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.
713
- * @param {string} inboundPlanId Identifier of an inbound plan.
714
- * @param {string} packingGroupId Identifier of a packing group.
715
- * @param {number} [pageSize] The number of packing group items to return in the response matching the given query.
716
- * @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.
717
- * @param {*} [options] Override http request option.
718
- * @throws {RequiredError}
719
- */
720
- listPackingGroupItems(inboundPlanId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPackingGroupItemsResponse>>;
721
- /**
722
- * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.
723
- * @param {string} inboundPlanId Identifier of an inbound plan.
724
- * @param {number} [pageSize] The number of packing options to return in the response matching the given query.
725
- * @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.
726
- * @param {*} [options] Override http request option.
727
- * @throws {RequiredError}
728
- */
729
- listPackingOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPackingOptionsResponse>>;
730
- /**
731
- * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.
732
- * @param {string} inboundPlanId Identifier of an inbound plan.
733
- * @param {number} [pageSize] The number of placement options to return in the response matching the given query.
734
- * @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.
735
- * @param {*} [options] Override http request option.
736
- * @throws {RequiredError}
737
- */
738
- listPlacementOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPlacementOptionsResponse>>;
739
- /**
740
- * Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
741
- * @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
742
- * @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
743
- * @param {*} [options] Override http request option.
744
- * @throws {RequiredError}
745
- */
746
- listPrepDetails(marketplaceId: string, mskus: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPrepDetailsResponse>>;
747
- /**
748
- * Provides a paginated list of box packages in a shipment.
749
- * @param {string} inboundPlanId Identifier of an inbound plan.
750
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
751
- * @param {number} [pageSize] The number of boxes to return in the response matching the given query.
752
- * @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.
753
- * @param {*} [options] Override http request option.
754
- * @throws {RequiredError}
755
- */
756
- listShipmentBoxes(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListShipmentBoxesResponse>>;
757
- /**
758
- * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
759
- * @param {string} inboundPlanId Identifier of an inbound plan.
760
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
761
- * @param {number} [pageSize] The number of content update previews to return.
762
- * @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.
763
- * @param {*} [options] Override http request option.
764
- * @throws {RequiredError}
765
- */
766
- listShipmentContentUpdatePreviews(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListShipmentContentUpdatePreviewsResponse>>;
767
- /**
768
- * Provides a paginated list of item packages in a shipment.
769
- * @param {string} inboundPlanId Identifier of an inbound plan.
770
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
771
- * @param {number} [pageSize] The number of items to return in the response matching the given query.
772
- * @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.
773
- * @param {*} [options] Override http request option.
774
- * @throws {RequiredError}
775
- */
776
- listShipmentItems(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListShipmentItemsResponse>>;
777
- /**
778
- * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
779
- * @param {string} inboundPlanId Identifier of an inbound plan.
780
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
781
- * @param {number} [pageSize] The number of pallets to return in the response matching the given query.
782
- * @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.
783
- * @param {*} [options] Override http request option.
784
- * @throws {RequiredError}
785
- */
786
- listShipmentPallets(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListShipmentPalletsResponse>>;
787
- /**
788
- * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available.
789
- * @param {string} inboundPlanId Identifier of an inbound plan.
790
- * @param {number} [pageSize] The number of transportation options to return in the response matching the given query.
791
- * @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.
792
- * @param {string} [placementOptionId] The placement option to get transportation options for. Either &#x60;placementOptionId&#x60; or &#x60;shipmentId&#x60; must be specified.
793
- * @param {string} [shipmentId] The shipment to get transportation options for. Either &#x60;placementOptionId&#x60; or &#x60;shipmentId&#x60; must be specified.
794
- * @param {*} [options] Override http request option.
795
- * @throws {RequiredError}
796
- */
797
- listTransportationOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, placementOptionId?: string, shipmentId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransportationOptionsResponse>>;
798
- /**
799
- * Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
800
- * @param {string} inboundPlanId Identifier of an inbound plan.
801
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
802
- * @param {string} slotId An identifier to a self-ship appointment slot.
803
- * @param {ScheduleSelfShipAppointmentRequest} body The body of the request to &#x60;scheduleSelfShipAppointment&#x60;.
804
- * @param {*} [options] Override http request option.
805
- * @throws {RequiredError}
806
- */
807
- scheduleSelfShipAppointment(inboundPlanId: string, shipmentId: string, slotId: string, body: ScheduleSelfShipAppointmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScheduleSelfShipAppointmentResponse>>;
808
- /**
809
- * 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.
810
- * @param {string} inboundPlanId Identifier of an inbound plan.
811
- * @param {SetPackingInformationRequest} body The body of the request to &#x60;setPackingInformation&#x60;.
812
- * @param {*} [options] Override http request option.
813
- * @throws {RequiredError}
814
- */
815
- setPackingInformation(inboundPlanId: string, body: SetPackingInformationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetPackingInformationResponse>>;
816
- /**
817
- * Set the preparation details for a list of MSKUs in a specified marketplace.
818
- * @param {SetPrepDetailsRequest} body The body of the request to &#x60;setPrepDetails&#x60;.
819
- * @param {*} [options] Override http request option.
820
- * @throws {RequiredError}
821
- */
822
- setPrepDetails(body: SetPrepDetailsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetPrepDetailsResponse>>;
823
- /**
824
- * Updates the name of an existing inbound plan.
825
- * @param {string} inboundPlanId Identifier of an inbound plan.
826
- * @param {UpdateInboundPlanNameRequest} body The body of the request to &#x60;updateInboundPlanName&#x60;.
827
- * @param {*} [options] Override http request option.
828
- * @throws {RequiredError}
829
- */
830
- updateInboundPlanName(inboundPlanId: string, body: UpdateInboundPlanNameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
831
- /**
832
- * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.
833
- * @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
834
- * @param {UpdateItemComplianceDetailsRequest} body The body of the request to &#x60;updateItemComplianceDetails&#x60;.
835
- * @param {*} [options] Override http request option.
836
- * @throws {RequiredError}
837
- */
838
- updateItemComplianceDetails(marketplaceId: string, body: UpdateItemComplianceDetailsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateItemComplianceDetailsResponse>>;
839
- /**
840
- * Updates the name of an existing shipment.
841
- * @param {string} inboundPlanId Identifier of an inbound plan.
842
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
843
- * @param {UpdateShipmentNameRequest} body The body of the request to &#x60;updateShipmentName&#x60;.
844
- * @param {*} [options] Override http request option.
845
- * @throws {RequiredError}
846
- */
847
- updateShipmentName(inboundPlanId: string, shipmentId: string, body: UpdateShipmentNameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
848
- /**
849
- * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.
850
- * @param {string} inboundPlanId Identifier of an inbound plan.
851
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
852
- * @param {UpdateShipmentSourceAddressRequest} body The body of the request to &#x60;updateShipmentSourceAddress&#x60;.
853
- * @param {*} [options] Override http request option.
854
- * @throws {RequiredError}
855
- */
856
- updateShipmentSourceAddress(inboundPlanId: string, shipmentId: string, body: UpdateShipmentSourceAddressRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateShipmentSourceAddressResponse>>;
857
- /**
858
- * Updates a shipment\'s tracking details.
859
- * @param {string} inboundPlanId Identifier of an inbound plan.
860
- * @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
861
- * @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to &#x60;updateShipmentTrackingDetails&#x60;.
862
- * @param {*} [options] Override http request option.
863
- * @throws {RequiredError}
864
- */
865
- updateShipmentTrackingDetails(inboundPlanId: string, shipmentId: string, body: UpdateShipmentTrackingDetailsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateShipmentTrackingDetailsResponse>>;
866
- };
867
- /**
868
- * FulfillmentInboundApi - factory interface
869
- */
870
- export declare const FulfillmentInboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
871
- /**
872
- * 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.
873
- * @param {FulfillmentInboundApiCancelInboundPlanRequest} requestParameters Request parameters.
874
- * @param {*} [options] Override http request option.
875
- * @throws {RequiredError}
876
- */
877
- cancelInboundPlan(requestParameters: FulfillmentInboundApiCancelInboundPlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<CancelInboundPlanResponse>;
878
- /**
879
- * Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
880
- * @param {FulfillmentInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
881
- * @param {*} [options] Override http request option.
882
- * @throws {RequiredError}
883
- */
884
- cancelSelfShipAppointment(requestParameters: FulfillmentInboundApiCancelSelfShipAppointmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<CancelSelfShipAppointmentResponse>;
885
- /**
886
- * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation.
887
- * @param {FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest} requestParameters Request parameters.
888
- * @param {*} [options] Override http request option.
889
- * @throws {RequiredError}
890
- */
891
- confirmDeliveryWindowOptions(requestParameters: FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConfirmDeliveryWindowOptionsResponse>;
892
- /**
893
- * Confirms the packing option for an inbound plan.
894
- * @param {FulfillmentInboundApiConfirmPackingOptionRequest} requestParameters Request parameters.
895
- * @param {*} [options] Override http request option.
896
- * @throws {RequiredError}
897
- */
898
- confirmPackingOption(requestParameters: FulfillmentInboundApiConfirmPackingOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConfirmPackingOptionResponse>;
899
- /**
900
- * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
901
- * @param {FulfillmentInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters.
902
- * @param {*} [options] Override http request option.
903
- * @throws {RequiredError}
904
- */
905
- confirmPlacementOption(requestParameters: FulfillmentInboundApiConfirmPlacementOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConfirmPlacementOptionResponse>;
906
- /**
907
- * Confirm a shipment content update preview and accept the changes in transportation cost.
908
- * @param {FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
909
- * @param {*} [options] Override http request option.
910
- * @throws {RequiredError}
911
- */
912
- confirmShipmentContentUpdatePreview(requestParameters: FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConfirmShipmentContentUpdatePreviewResponse>;
913
- /**
914
- * 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.
915
- * @param {FulfillmentInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters.
916
- * @param {*} [options] Override http request option.
917
- * @throws {RequiredError}
918
- */
919
- confirmTransportationOptions(requestParameters: FulfillmentInboundApiConfirmTransportationOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConfirmTransportationOptionsResponse>;
920
- /**
921
- * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network.
922
- * @param {FulfillmentInboundApiCreateInboundPlanRequest} requestParameters Request parameters.
923
- * @param {*} [options] Override http request option.
924
- * @throws {RequiredError}
925
- */
926
- createInboundPlan(requestParameters: FulfillmentInboundApiCreateInboundPlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateInboundPlanResponse>;
927
- /**
928
- * For a given marketplace - creates labels for a list of MSKUs.
929
- * @param {FulfillmentInboundApiCreateMarketplaceItemLabelsRequest} requestParameters Request parameters.
930
- * @param {*} [options] Override http request option.
931
- * @throws {RequiredError}
932
- */
933
- createMarketplaceItemLabels(requestParameters: FulfillmentInboundApiCreateMarketplaceItemLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateMarketplaceItemLabelsResponse>;
934
- /**
935
- * Generates available delivery window options for a given shipment.
936
- * @param {FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest} requestParameters Request parameters.
937
- * @param {*} [options] Override http request option.
938
- * @throws {RequiredError}
939
- */
940
- generateDeliveryWindowOptions(requestParameters: FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateDeliveryWindowOptionsResponse>;
941
- /**
942
- * Generates available packing options for the inbound plan.
943
- * @param {FulfillmentInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters.
944
- * @param {*} [options] Override http request option.
945
- * @throws {RequiredError}
946
- */
947
- generatePackingOptions(requestParameters: FulfillmentInboundApiGeneratePackingOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GeneratePackingOptionsResponse>;
948
- /**
949
- * Generates placement options for the inbound plan.
950
- * @param {FulfillmentInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters.
951
- * @param {*} [options] Override http request option.
952
- * @throws {RequiredError}
953
- */
954
- generatePlacementOptions(requestParameters: FulfillmentInboundApiGeneratePlacementOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GeneratePlacementOptionsResponse>;
955
- /**
956
- * Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
957
- * @param {FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
958
- * @param {*} [options] Override http request option.
959
- * @throws {RequiredError}
960
- */
961
- generateSelfShipAppointmentSlots(requestParameters: FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>;
962
- /**
963
- * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.
964
- * @param {FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
965
- * @param {*} [options] Override http request option.
966
- * @throws {RequiredError}
967
- */
968
- generateShipmentContentUpdatePreviews(requestParameters: FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateShipmentContentUpdatePreviewsResponse>;
969
- /**
970
- * Generates available transportation options for a given placement option.
971
- * @param {FulfillmentInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters.
972
- * @param {*} [options] Override http request option.
973
- * @throws {RequiredError}
974
- */
975
- generateTransportationOptions(requestParameters: FulfillmentInboundApiGenerateTransportationOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateTransportationOptionsResponse>;
976
- /**
977
- * Provide delivery challan document for PCP transportation in IN marketplace.
978
- * @param {FulfillmentInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters.
979
- * @param {*} [options] Override http request option.
980
- * @throws {RequiredError}
981
- */
982
- getDeliveryChallanDocument(requestParameters: FulfillmentInboundApiGetDeliveryChallanDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeliveryChallanDocumentResponse>;
983
- /**
984
- * Gets the status of the processing of an asynchronous API call.
985
- * @param {FulfillmentInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters.
986
- * @param {*} [options] Override http request option.
987
- * @throws {RequiredError}
988
- */
989
- getInboundOperationStatus(requestParameters: FulfillmentInboundApiGetInboundOperationStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<InboundOperationStatus>;
990
- /**
991
- * Fetches the top level information about an inbound plan.
992
- * @param {FulfillmentInboundApiGetInboundPlanRequest} requestParameters Request parameters.
993
- * @param {*} [options] Override http request option.
994
- * @throws {RequiredError}
995
- */
996
- getInboundPlan(requestParameters: FulfillmentInboundApiGetInboundPlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<InboundPlan>;
997
- /**
998
- * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
999
- * @param {FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
1000
- * @param {*} [options] Override http request option.
1001
- * @throws {RequiredError}
1002
- */
1003
- getSelfShipAppointmentSlots(requestParameters: FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSelfShipAppointmentSlotsResponse>;
1004
- /**
1005
- * 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.
1006
- * @param {FulfillmentInboundApiGetShipmentRequest} requestParameters Request parameters.
1007
- * @param {*} [options] Override http request option.
1008
- * @throws {RequiredError}
1009
- */
1010
- getShipment(requestParameters: FulfillmentInboundApiGetShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Shipment>;
1011
- /**
1012
- * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
1013
- * @param {FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
1014
- * @param {*} [options] Override http request option.
1015
- * @throws {RequiredError}
1016
- */
1017
- getShipmentContentUpdatePreview(requestParameters: FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<ContentUpdatePreview>;
1018
- /**
1019
- * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available.
1020
- * @param {FulfillmentInboundApiListDeliveryWindowOptionsRequest} requestParameters Request parameters.
1021
- * @param {*} [options] Override http request option.
1022
- * @throws {RequiredError}
1023
- */
1024
- listDeliveryWindowOptions(requestParameters: FulfillmentInboundApiListDeliveryWindowOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDeliveryWindowOptionsResponse>;
1025
- /**
1026
- * Provides a paginated list of box packages in an inbound plan.
1027
- * @param {FulfillmentInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters.
1028
- * @param {*} [options] Override http request option.
1029
- * @throws {RequiredError}
1030
- */
1031
- listInboundPlanBoxes(requestParameters: FulfillmentInboundApiListInboundPlanBoxesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListInboundPlanBoxesResponse>;
1032
- /**
1033
- * Provides a paginated list of item packages in an inbound plan.
1034
- * @param {FulfillmentInboundApiListInboundPlanItemsRequest} requestParameters Request parameters.
1035
- * @param {*} [options] Override http request option.
1036
- * @throws {RequiredError}
1037
- */
1038
- listInboundPlanItems(requestParameters: FulfillmentInboundApiListInboundPlanItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListInboundPlanItemsResponse>;
1039
- /**
1040
- * 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.
1041
- * @param {FulfillmentInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters.
1042
- * @param {*} [options] Override http request option.
1043
- * @throws {RequiredError}
1044
- */
1045
- listInboundPlanPallets(requestParameters: FulfillmentInboundApiListInboundPlanPalletsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListInboundPlanPalletsResponse>;
1046
- /**
1047
- * Provides a list of inbound plans with minimal information.
1048
- * @param {FulfillmentInboundApiListInboundPlansRequest} requestParameters Request parameters.
1049
- * @param {*} [options] Override http request option.
1050
- * @throws {RequiredError}
1051
- */
1052
- listInboundPlans(requestParameters?: FulfillmentInboundApiListInboundPlansRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListInboundPlansResponse>;
1053
- /**
1054
- * List the inbound compliance details for MSKUs in a given marketplace. **Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). The following characters must be double percent encoded: - `%` - `+` - `,` **Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
1055
- * @param {FulfillmentInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
1056
- * @param {*} [options] Override http request option.
1057
- * @throws {RequiredError}
1058
- */
1059
- listItemComplianceDetails(requestParameters: FulfillmentInboundApiListItemComplianceDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListItemComplianceDetailsResponse>;
1060
- /**
1061
- * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.
1062
- * @param {FulfillmentInboundApiListPackingGroupBoxesRequest} requestParameters Request parameters.
1063
- * @param {*} [options] Override http request option.
1064
- * @throws {RequiredError}
1065
- */
1066
- listPackingGroupBoxes(requestParameters: FulfillmentInboundApiListPackingGroupBoxesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPackingGroupBoxesResponse>;
1067
- /**
1068
- * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.
1069
- * @param {FulfillmentInboundApiListPackingGroupItemsRequest} requestParameters Request parameters.
1070
- * @param {*} [options] Override http request option.
1071
- * @throws {RequiredError}
1072
- */
1073
- listPackingGroupItems(requestParameters: FulfillmentInboundApiListPackingGroupItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPackingGroupItemsResponse>;
1074
- /**
1075
- * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.
1076
- * @param {FulfillmentInboundApiListPackingOptionsRequest} requestParameters Request parameters.
1077
- * @param {*} [options] Override http request option.
1078
- * @throws {RequiredError}
1079
- */
1080
- listPackingOptions(requestParameters: FulfillmentInboundApiListPackingOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPackingOptionsResponse>;
1081
- /**
1082
- * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.
1083
- * @param {FulfillmentInboundApiListPlacementOptionsRequest} requestParameters Request parameters.
1084
- * @param {*} [options] Override http request option.
1085
- * @throws {RequiredError}
1086
- */
1087
- listPlacementOptions(requestParameters: FulfillmentInboundApiListPlacementOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPlacementOptionsResponse>;
1088
- /**
1089
- * Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
1090
- * @param {FulfillmentInboundApiListPrepDetailsRequest} requestParameters Request parameters.
1091
- * @param {*} [options] Override http request option.
1092
- * @throws {RequiredError}
1093
- */
1094
- listPrepDetails(requestParameters: FulfillmentInboundApiListPrepDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPrepDetailsResponse>;
1095
- /**
1096
- * Provides a paginated list of box packages in a shipment.
1097
- * @param {FulfillmentInboundApiListShipmentBoxesRequest} requestParameters Request parameters.
1098
- * @param {*} [options] Override http request option.
1099
- * @throws {RequiredError}
1100
- */
1101
- listShipmentBoxes(requestParameters: FulfillmentInboundApiListShipmentBoxesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListShipmentBoxesResponse>;
1102
- /**
1103
- * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
1104
- * @param {FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
1105
- * @param {*} [options] Override http request option.
1106
- * @throws {RequiredError}
1107
- */
1108
- listShipmentContentUpdatePreviews(requestParameters: FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListShipmentContentUpdatePreviewsResponse>;
1109
- /**
1110
- * Provides a paginated list of item packages in a shipment.
1111
- * @param {FulfillmentInboundApiListShipmentItemsRequest} requestParameters Request parameters.
1112
- * @param {*} [options] Override http request option.
1113
- * @throws {RequiredError}
1114
- */
1115
- listShipmentItems(requestParameters: FulfillmentInboundApiListShipmentItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListShipmentItemsResponse>;
1116
- /**
1117
- * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
1118
- * @param {FulfillmentInboundApiListShipmentPalletsRequest} requestParameters Request parameters.
1119
- * @param {*} [options] Override http request option.
1120
- * @throws {RequiredError}
1121
- */
1122
- listShipmentPallets(requestParameters: FulfillmentInboundApiListShipmentPalletsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListShipmentPalletsResponse>;
1123
- /**
1124
- * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available.
1125
- * @param {FulfillmentInboundApiListTransportationOptionsRequest} requestParameters Request parameters.
1126
- * @param {*} [options] Override http request option.
1127
- * @throws {RequiredError}
1128
- */
1129
- listTransportationOptions(requestParameters: FulfillmentInboundApiListTransportationOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransportationOptionsResponse>;
1130
- /**
1131
- * Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
1132
- * @param {FulfillmentInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
1133
- * @param {*} [options] Override http request option.
1134
- * @throws {RequiredError}
1135
- */
1136
- scheduleSelfShipAppointment(requestParameters: FulfillmentInboundApiScheduleSelfShipAppointmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ScheduleSelfShipAppointmentResponse>;
1137
- /**
1138
- * 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.
1139
- * @param {FulfillmentInboundApiSetPackingInformationRequest} requestParameters Request parameters.
1140
- * @param {*} [options] Override http request option.
1141
- * @throws {RequiredError}
1142
- */
1143
- setPackingInformation(requestParameters: FulfillmentInboundApiSetPackingInformationRequest, options?: RawAxiosRequestConfig): AxiosPromise<SetPackingInformationResponse>;
1144
- /**
1145
- * Set the preparation details for a list of MSKUs in a specified marketplace.
1146
- * @param {FulfillmentInboundApiSetPrepDetailsRequest} requestParameters Request parameters.
1147
- * @param {*} [options] Override http request option.
1148
- * @throws {RequiredError}
1149
- */
1150
- setPrepDetails(requestParameters: FulfillmentInboundApiSetPrepDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SetPrepDetailsResponse>;
1151
- /**
1152
- * Updates the name of an existing inbound plan.
1153
- * @param {FulfillmentInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters.
1154
- * @param {*} [options] Override http request option.
1155
- * @throws {RequiredError}
1156
- */
1157
- updateInboundPlanName(requestParameters: FulfillmentInboundApiUpdateInboundPlanNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1158
- /**
1159
- * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.
1160
- * @param {FulfillmentInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters.
1161
- * @param {*} [options] Override http request option.
1162
- * @throws {RequiredError}
1163
- */
1164
- updateItemComplianceDetails(requestParameters: FulfillmentInboundApiUpdateItemComplianceDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateItemComplianceDetailsResponse>;
1165
- /**
1166
- * Updates the name of an existing shipment.
1167
- * @param {FulfillmentInboundApiUpdateShipmentNameRequest} requestParameters Request parameters.
1168
- * @param {*} [options] Override http request option.
1169
- * @throws {RequiredError}
1170
- */
1171
- updateShipmentName(requestParameters: FulfillmentInboundApiUpdateShipmentNameRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1172
- /**
1173
- * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.
1174
- * @param {FulfillmentInboundApiUpdateShipmentSourceAddressRequest} requestParameters Request parameters.
1175
- * @param {*} [options] Override http request option.
1176
- * @throws {RequiredError}
1177
- */
1178
- updateShipmentSourceAddress(requestParameters: FulfillmentInboundApiUpdateShipmentSourceAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateShipmentSourceAddressResponse>;
1179
- /**
1180
- * Updates a shipment\'s tracking details.
1181
- * @param {FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters.
1182
- * @param {*} [options] Override http request option.
1183
- * @throws {RequiredError}
1184
- */
1185
- updateShipmentTrackingDetails(requestParameters: FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateShipmentTrackingDetailsResponse>;
1186
- };
1187
- /**
1188
- * Request parameters for cancelInboundPlan operation in FulfillmentInboundApi.
1189
- */
1190
- export interface FulfillmentInboundApiCancelInboundPlanRequest {
1191
- /**
1192
- * Identifier of an inbound plan.
1193
- */
1194
- readonly inboundPlanId: string;
1195
- }
1196
- /**
1197
- * Request parameters for cancelSelfShipAppointment operation in FulfillmentInboundApi.
1198
- */
1199
- export interface FulfillmentInboundApiCancelSelfShipAppointmentRequest {
1200
- /**
1201
- * Identifier of an inbound plan.
1202
- */
1203
- readonly inboundPlanId: string;
1204
- /**
1205
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1206
- */
1207
- readonly shipmentId: string;
1208
- /**
1209
- * The body of the request to &#x60;cancelSelfShipAppointment&#x60;.
1210
- */
1211
- readonly body: CancelSelfShipAppointmentRequest;
1212
- }
1213
- /**
1214
- * Request parameters for confirmDeliveryWindowOptions operation in FulfillmentInboundApi.
1215
- */
1216
- export interface FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest {
1217
- /**
1218
- * Identifier of an inbound plan.
1219
- */
1220
- readonly inboundPlanId: string;
1221
- /**
1222
- * The shipment to confirm the delivery window option for.
1223
- */
1224
- readonly shipmentId: string;
1225
- /**
1226
- * The id of the delivery window option to be confirmed.
1227
- */
1228
- readonly deliveryWindowOptionId: string;
1229
- }
1230
- /**
1231
- * Request parameters for confirmPackingOption operation in FulfillmentInboundApi.
1232
- */
1233
- export interface FulfillmentInboundApiConfirmPackingOptionRequest {
1234
- /**
1235
- * Identifier of an inbound plan.
1236
- */
1237
- readonly inboundPlanId: string;
1238
- /**
1239
- * Identifier of a packing option.
1240
- */
1241
- readonly packingOptionId: string;
1242
- }
1243
- /**
1244
- * Request parameters for confirmPlacementOption operation in FulfillmentInboundApi.
1245
- */
1246
- export interface FulfillmentInboundApiConfirmPlacementOptionRequest {
1247
- /**
1248
- * Identifier of an inbound plan.
1249
- */
1250
- readonly inboundPlanId: string;
1251
- /**
1252
- * The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
1253
- */
1254
- readonly placementOptionId: string;
1255
- }
1256
- /**
1257
- * Request parameters for confirmShipmentContentUpdatePreview operation in FulfillmentInboundApi.
1258
- */
1259
- export interface FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest {
1260
- /**
1261
- * Identifier of an inbound plan.
1262
- */
1263
- readonly inboundPlanId: string;
1264
- /**
1265
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1266
- */
1267
- readonly shipmentId: string;
1268
- /**
1269
- * Identifier of a content update preview.
1270
- */
1271
- readonly contentUpdatePreviewId: string;
1272
- }
1273
- /**
1274
- * Request parameters for confirmTransportationOptions operation in FulfillmentInboundApi.
1275
- */
1276
- export interface FulfillmentInboundApiConfirmTransportationOptionsRequest {
1277
- /**
1278
- * Identifier of an inbound plan.
1279
- */
1280
- readonly inboundPlanId: string;
1281
- /**
1282
- * The body of the request to &#x60;confirmTransportationOptions&#x60;.
1283
- */
1284
- readonly body: ConfirmTransportationOptionsRequest;
1285
- }
1286
- /**
1287
- * Request parameters for createInboundPlan operation in FulfillmentInboundApi.
1288
- */
1289
- export interface FulfillmentInboundApiCreateInboundPlanRequest {
1290
- /**
1291
- * The body of the request to &#x60;createInboundPlan&#x60;.
1292
- */
1293
- readonly body: CreateInboundPlanRequest;
1294
- }
1295
- /**
1296
- * Request parameters for createMarketplaceItemLabels operation in FulfillmentInboundApi.
1297
- */
1298
- export interface FulfillmentInboundApiCreateMarketplaceItemLabelsRequest {
1299
- /**
1300
- * The body of the request to &#x60;createMarketplaceItemLabels&#x60;.
1301
- */
1302
- readonly body: CreateMarketplaceItemLabelsRequest;
1303
- }
1304
- /**
1305
- * Request parameters for generateDeliveryWindowOptions operation in FulfillmentInboundApi.
1306
- */
1307
- export interface FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest {
1308
- /**
1309
- * Identifier of an inbound plan.
1310
- */
1311
- readonly inboundPlanId: string;
1312
- /**
1313
- * The shipment to generate delivery window options for.
1314
- */
1315
- readonly shipmentId: string;
1316
- }
1317
- /**
1318
- * Request parameters for generatePackingOptions operation in FulfillmentInboundApi.
1319
- */
1320
- export interface FulfillmentInboundApiGeneratePackingOptionsRequest {
1321
- /**
1322
- * Identifier of an inbound plan.
1323
- */
1324
- readonly inboundPlanId: string;
1325
- }
1326
- /**
1327
- * Request parameters for generatePlacementOptions operation in FulfillmentInboundApi.
1328
- */
1329
- export interface FulfillmentInboundApiGeneratePlacementOptionsRequest {
1330
- /**
1331
- * Identifier of an inbound plan.
1332
- */
1333
- readonly inboundPlanId: string;
1334
- /**
1335
- * The body of the request to &#x60;generatePlacementOptions&#x60;.
1336
- */
1337
- readonly body: GeneratePlacementOptionsRequest;
1338
- }
1339
- /**
1340
- * Request parameters for generateSelfShipAppointmentSlots operation in FulfillmentInboundApi.
1341
- */
1342
- export interface FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest {
1343
- /**
1344
- * Identifier of an inbound plan.
1345
- */
1346
- readonly inboundPlanId: string;
1347
- /**
1348
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1349
- */
1350
- readonly shipmentId: string;
1351
- /**
1352
- * The body of the request to &#x60;generateSelfShipAppointmentSlots&#x60;.
1353
- */
1354
- readonly body: GenerateSelfShipAppointmentSlotsRequest;
1355
- }
1356
- /**
1357
- * Request parameters for generateShipmentContentUpdatePreviews operation in FulfillmentInboundApi.
1358
- */
1359
- export interface FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest {
1360
- /**
1361
- * Identifier of an inbound plan.
1362
- */
1363
- readonly inboundPlanId: string;
1364
- /**
1365
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1366
- */
1367
- readonly shipmentId: string;
1368
- /**
1369
- * The body of the request to &#x60;generateShipmentContentUpdatePreviews&#x60;.
1370
- */
1371
- readonly body: GenerateShipmentContentUpdatePreviewsRequest;
1372
- }
1373
- /**
1374
- * Request parameters for generateTransportationOptions operation in FulfillmentInboundApi.
1375
- */
1376
- export interface FulfillmentInboundApiGenerateTransportationOptionsRequest {
1377
- /**
1378
- * Identifier of an inbound plan.
1379
- */
1380
- readonly inboundPlanId: string;
1381
- /**
1382
- * The body of the request to &#x60;generateTransportationOptions&#x60;.
1383
- */
1384
- readonly body: GenerateTransportationOptionsRequest;
1385
- }
1386
- /**
1387
- * Request parameters for getDeliveryChallanDocument operation in FulfillmentInboundApi.
1388
- */
1389
- export interface FulfillmentInboundApiGetDeliveryChallanDocumentRequest {
1390
- /**
1391
- * Identifier of an inbound plan.
1392
- */
1393
- readonly inboundPlanId: string;
1394
- /**
1395
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1396
- */
1397
- readonly shipmentId: string;
1398
- }
1399
- /**
1400
- * Request parameters for getInboundOperationStatus operation in FulfillmentInboundApi.
1401
- */
1402
- export interface FulfillmentInboundApiGetInboundOperationStatusRequest {
1403
- /**
1404
- * Identifier of an asynchronous operation.
1405
- */
1406
- readonly operationId: string;
1407
- }
1408
- /**
1409
- * Request parameters for getInboundPlan operation in FulfillmentInboundApi.
1410
- */
1411
- export interface FulfillmentInboundApiGetInboundPlanRequest {
1412
- /**
1413
- * Identifier of an inbound plan.
1414
- */
1415
- readonly inboundPlanId: string;
1416
- }
1417
- /**
1418
- * Request parameters for getSelfShipAppointmentSlots operation in FulfillmentInboundApi.
1419
- */
1420
- export interface FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest {
1421
- /**
1422
- * Identifier of an inbound plan.
1423
- */
1424
- readonly inboundPlanId: string;
1425
- /**
1426
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1427
- */
1428
- readonly shipmentId: string;
1429
- /**
1430
- * The number of self ship appointment slots to return in the response matching the given query.
1431
- */
1432
- readonly pageSize?: number;
1433
- /**
1434
- * 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.
1435
- */
1436
- readonly paginationToken?: string;
1437
- }
1438
- /**
1439
- * Request parameters for getShipment operation in FulfillmentInboundApi.
1440
- */
1441
- export interface FulfillmentInboundApiGetShipmentRequest {
1442
- /**
1443
- * Identifier of an inbound plan.
1444
- */
1445
- readonly inboundPlanId: string;
1446
- /**
1447
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1448
- */
1449
- readonly shipmentId: string;
1450
- }
1451
- /**
1452
- * Request parameters for getShipmentContentUpdatePreview operation in FulfillmentInboundApi.
1453
- */
1454
- export interface FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest {
1455
- /**
1456
- * Identifier of an inbound plan.
1457
- */
1458
- readonly inboundPlanId: string;
1459
- /**
1460
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1461
- */
1462
- readonly shipmentId: string;
1463
- /**
1464
- * Identifier of a content update preview.
1465
- */
1466
- readonly contentUpdatePreviewId: string;
1467
- }
1468
- /**
1469
- * Request parameters for listDeliveryWindowOptions operation in FulfillmentInboundApi.
1470
- */
1471
- export interface FulfillmentInboundApiListDeliveryWindowOptionsRequest {
1472
- /**
1473
- * Identifier of an inbound plan.
1474
- */
1475
- readonly inboundPlanId: string;
1476
- /**
1477
- * The shipment to get delivery window options for.
1478
- */
1479
- readonly shipmentId: string;
1480
- /**
1481
- * The number of delivery window options to return in the response matching the given query.
1482
- */
1483
- readonly pageSize?: number;
1484
- /**
1485
- * 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.
1486
- */
1487
- readonly paginationToken?: string;
1488
- }
1489
- /**
1490
- * Request parameters for listInboundPlanBoxes operation in FulfillmentInboundApi.
1491
- */
1492
- export interface FulfillmentInboundApiListInboundPlanBoxesRequest {
1493
- /**
1494
- * Identifier of an inbound plan.
1495
- */
1496
- readonly inboundPlanId: string;
1497
- /**
1498
- * The number of boxes to return in the response matching the given query.
1499
- */
1500
- readonly pageSize?: number;
1501
- /**
1502
- * 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.
1503
- */
1504
- readonly paginationToken?: string;
1505
- }
1506
- /**
1507
- * Request parameters for listInboundPlanItems operation in FulfillmentInboundApi.
1508
- */
1509
- export interface FulfillmentInboundApiListInboundPlanItemsRequest {
1510
- /**
1511
- * Identifier of an inbound plan.
1512
- */
1513
- readonly inboundPlanId: string;
1514
- /**
1515
- * The number of items to return in the response matching the given query.
1516
- */
1517
- readonly pageSize?: number;
1518
- /**
1519
- * 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.
1520
- */
1521
- readonly paginationToken?: string;
1522
- }
1523
- /**
1524
- * Request parameters for listInboundPlanPallets operation in FulfillmentInboundApi.
1525
- */
1526
- export interface FulfillmentInboundApiListInboundPlanPalletsRequest {
1527
- /**
1528
- * Identifier of an inbound plan.
1529
- */
1530
- readonly inboundPlanId: string;
1531
- /**
1532
- * The number of pallets to return in the response matching the given query.
1533
- */
1534
- readonly pageSize?: number;
1535
- /**
1536
- * 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.
1537
- */
1538
- readonly paginationToken?: string;
1539
- }
1540
- /**
1541
- * Request parameters for listInboundPlans operation in FulfillmentInboundApi.
1542
- */
1543
- export interface FulfillmentInboundApiListInboundPlansRequest {
1544
- /**
1545
- * The number of inbound plans to return in the response matching the given query.
1546
- */
1547
- readonly pageSize?: number;
1548
- /**
1549
- * 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.
1550
- */
1551
- readonly paginationToken?: string;
1552
- /**
1553
- * The status of an inbound plan.
1554
- */
1555
- readonly status?: ListInboundPlansStatusEnum;
1556
- /**
1557
- * Sort by field.
1558
- */
1559
- readonly sortBy?: ListInboundPlansSortByEnum;
1560
- /**
1561
- * The sort order.
1562
- */
1563
- readonly sortOrder?: ListInboundPlansSortOrderEnum;
1564
- }
1565
- /**
1566
- * Request parameters for listItemComplianceDetails operation in FulfillmentInboundApi.
1567
- */
1568
- export interface FulfillmentInboundApiListItemComplianceDetailsRequest {
1569
- /**
1570
- * A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
1571
- */
1572
- readonly mskus: Array<string>;
1573
- /**
1574
- * The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
1575
- */
1576
- readonly marketplaceId: string;
1577
- }
1578
- /**
1579
- * Request parameters for listPackingGroupBoxes operation in FulfillmentInboundApi.
1580
- */
1581
- export interface FulfillmentInboundApiListPackingGroupBoxesRequest {
1582
- /**
1583
- * Identifier of an inbound plan.
1584
- */
1585
- readonly inboundPlanId: string;
1586
- /**
1587
- * Identifier of a packing group.
1588
- */
1589
- readonly packingGroupId: string;
1590
- /**
1591
- * The number of packing group boxes to return in the response matching the given query.
1592
- */
1593
- readonly pageSize?: number;
1594
- /**
1595
- * 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.
1596
- */
1597
- readonly paginationToken?: string;
1598
- }
1599
- /**
1600
- * Request parameters for listPackingGroupItems operation in FulfillmentInboundApi.
1601
- */
1602
- export interface FulfillmentInboundApiListPackingGroupItemsRequest {
1603
- /**
1604
- * Identifier of an inbound plan.
1605
- */
1606
- readonly inboundPlanId: string;
1607
- /**
1608
- * Identifier of a packing group.
1609
- */
1610
- readonly packingGroupId: string;
1611
- /**
1612
- * The number of packing group items to return in the response matching the given query.
1613
- */
1614
- readonly pageSize?: number;
1615
- /**
1616
- * 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.
1617
- */
1618
- readonly paginationToken?: string;
1619
- }
1620
- /**
1621
- * Request parameters for listPackingOptions operation in FulfillmentInboundApi.
1622
- */
1623
- export interface FulfillmentInboundApiListPackingOptionsRequest {
1624
- /**
1625
- * Identifier of an inbound plan.
1626
- */
1627
- readonly inboundPlanId: string;
1628
- /**
1629
- * The number of packing options to return in the response matching the given query.
1630
- */
1631
- readonly pageSize?: number;
1632
- /**
1633
- * 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.
1634
- */
1635
- readonly paginationToken?: string;
1636
- }
1637
- /**
1638
- * Request parameters for listPlacementOptions operation in FulfillmentInboundApi.
1639
- */
1640
- export interface FulfillmentInboundApiListPlacementOptionsRequest {
1641
- /**
1642
- * Identifier of an inbound plan.
1643
- */
1644
- readonly inboundPlanId: string;
1645
- /**
1646
- * The number of placement options to return in the response matching the given query.
1647
- */
1648
- readonly pageSize?: number;
1649
- /**
1650
- * 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.
1651
- */
1652
- readonly paginationToken?: string;
1653
- }
1654
- /**
1655
- * Request parameters for listPrepDetails operation in FulfillmentInboundApi.
1656
- */
1657
- export interface FulfillmentInboundApiListPrepDetailsRequest {
1658
- /**
1659
- * The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
1660
- */
1661
- readonly marketplaceId: string;
1662
- /**
1663
- * A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
1664
- */
1665
- readonly mskus: Array<string>;
1666
- }
1667
- /**
1668
- * Request parameters for listShipmentBoxes operation in FulfillmentInboundApi.
1669
- */
1670
- export interface FulfillmentInboundApiListShipmentBoxesRequest {
1671
- /**
1672
- * Identifier of an inbound plan.
1673
- */
1674
- readonly inboundPlanId: string;
1675
- /**
1676
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1677
- */
1678
- readonly shipmentId: string;
1679
- /**
1680
- * The number of boxes to return in the response matching the given query.
1681
- */
1682
- readonly pageSize?: number;
1683
- /**
1684
- * 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.
1685
- */
1686
- readonly paginationToken?: string;
1687
- }
1688
- /**
1689
- * Request parameters for listShipmentContentUpdatePreviews operation in FulfillmentInboundApi.
1690
- */
1691
- export interface FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest {
1692
- /**
1693
- * Identifier of an inbound plan.
1694
- */
1695
- readonly inboundPlanId: string;
1696
- /**
1697
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1698
- */
1699
- readonly shipmentId: string;
1700
- /**
1701
- * The number of content update previews to return.
1702
- */
1703
- readonly pageSize?: number;
1704
- /**
1705
- * 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.
1706
- */
1707
- readonly paginationToken?: string;
1708
- }
1709
- /**
1710
- * Request parameters for listShipmentItems operation in FulfillmentInboundApi.
1711
- */
1712
- export interface FulfillmentInboundApiListShipmentItemsRequest {
1713
- /**
1714
- * Identifier of an inbound plan.
1715
- */
1716
- readonly inboundPlanId: string;
1717
- /**
1718
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1719
- */
1720
- readonly shipmentId: string;
1721
- /**
1722
- * The number of items to return in the response matching the given query.
1723
- */
1724
- readonly pageSize?: number;
1725
- /**
1726
- * 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.
1727
- */
1728
- readonly paginationToken?: string;
1729
- }
1730
- /**
1731
- * Request parameters for listShipmentPallets operation in FulfillmentInboundApi.
1732
- */
1733
- export interface FulfillmentInboundApiListShipmentPalletsRequest {
1734
- /**
1735
- * Identifier of an inbound plan.
1736
- */
1737
- readonly inboundPlanId: string;
1738
- /**
1739
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1740
- */
1741
- readonly shipmentId: string;
1742
- /**
1743
- * The number of pallets to return in the response matching the given query.
1744
- */
1745
- readonly pageSize?: number;
1746
- /**
1747
- * 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.
1748
- */
1749
- readonly paginationToken?: string;
1750
- }
1751
- /**
1752
- * Request parameters for listTransportationOptions operation in FulfillmentInboundApi.
1753
- */
1754
- export interface FulfillmentInboundApiListTransportationOptionsRequest {
1755
- /**
1756
- * Identifier of an inbound plan.
1757
- */
1758
- readonly inboundPlanId: string;
1759
- /**
1760
- * The number of transportation options to return in the response matching the given query.
1761
- */
1762
- readonly pageSize?: number;
1763
- /**
1764
- * 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.
1765
- */
1766
- readonly paginationToken?: string;
1767
- /**
1768
- * The placement option to get transportation options for. Either &#x60;placementOptionId&#x60; or &#x60;shipmentId&#x60; must be specified.
1769
- */
1770
- readonly placementOptionId?: string;
1771
- /**
1772
- * The shipment to get transportation options for. Either &#x60;placementOptionId&#x60; or &#x60;shipmentId&#x60; must be specified.
1773
- */
1774
- readonly shipmentId?: string;
1775
- }
1776
- /**
1777
- * Request parameters for scheduleSelfShipAppointment operation in FulfillmentInboundApi.
1778
- */
1779
- export interface FulfillmentInboundApiScheduleSelfShipAppointmentRequest {
1780
- /**
1781
- * Identifier of an inbound plan.
1782
- */
1783
- readonly inboundPlanId: string;
1784
- /**
1785
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1786
- */
1787
- readonly shipmentId: string;
1788
- /**
1789
- * An identifier to a self-ship appointment slot.
1790
- */
1791
- readonly slotId: string;
1792
- /**
1793
- * The body of the request to &#x60;scheduleSelfShipAppointment&#x60;.
1794
- */
1795
- readonly body: ScheduleSelfShipAppointmentRequest;
1796
- }
1797
- /**
1798
- * Request parameters for setPackingInformation operation in FulfillmentInboundApi.
1799
- */
1800
- export interface FulfillmentInboundApiSetPackingInformationRequest {
1801
- /**
1802
- * Identifier of an inbound plan.
1803
- */
1804
- readonly inboundPlanId: string;
1805
- /**
1806
- * The body of the request to &#x60;setPackingInformation&#x60;.
1807
- */
1808
- readonly body: SetPackingInformationRequest;
1809
- }
1810
- /**
1811
- * Request parameters for setPrepDetails operation in FulfillmentInboundApi.
1812
- */
1813
- export interface FulfillmentInboundApiSetPrepDetailsRequest {
1814
- /**
1815
- * The body of the request to &#x60;setPrepDetails&#x60;.
1816
- */
1817
- readonly body: SetPrepDetailsRequest;
1818
- }
1819
- /**
1820
- * Request parameters for updateInboundPlanName operation in FulfillmentInboundApi.
1821
- */
1822
- export interface FulfillmentInboundApiUpdateInboundPlanNameRequest {
1823
- /**
1824
- * Identifier of an inbound plan.
1825
- */
1826
- readonly inboundPlanId: string;
1827
- /**
1828
- * The body of the request to &#x60;updateInboundPlanName&#x60;.
1829
- */
1830
- readonly body: UpdateInboundPlanNameRequest;
1831
- }
1832
- /**
1833
- * Request parameters for updateItemComplianceDetails operation in FulfillmentInboundApi.
1834
- */
1835
- export interface FulfillmentInboundApiUpdateItemComplianceDetailsRequest {
1836
- /**
1837
- * The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
1838
- */
1839
- readonly marketplaceId: string;
1840
- /**
1841
- * The body of the request to &#x60;updateItemComplianceDetails&#x60;.
1842
- */
1843
- readonly body: UpdateItemComplianceDetailsRequest;
1844
- }
1845
- /**
1846
- * Request parameters for updateShipmentName operation in FulfillmentInboundApi.
1847
- */
1848
- export interface FulfillmentInboundApiUpdateShipmentNameRequest {
1849
- /**
1850
- * Identifier of an inbound plan.
1851
- */
1852
- readonly inboundPlanId: string;
1853
- /**
1854
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1855
- */
1856
- readonly shipmentId: string;
1857
- /**
1858
- * The body of the request to &#x60;updateShipmentName&#x60;.
1859
- */
1860
- readonly body: UpdateShipmentNameRequest;
1861
- }
1862
- /**
1863
- * Request parameters for updateShipmentSourceAddress operation in FulfillmentInboundApi.
1864
- */
1865
- export interface FulfillmentInboundApiUpdateShipmentSourceAddressRequest {
1866
- /**
1867
- * Identifier of an inbound plan.
1868
- */
1869
- readonly inboundPlanId: string;
1870
- /**
1871
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1872
- */
1873
- readonly shipmentId: string;
1874
- /**
1875
- * The body of the request to &#x60;updateShipmentSourceAddress&#x60;.
1876
- */
1877
- readonly body: UpdateShipmentSourceAddressRequest;
1878
- }
1879
- /**
1880
- * Request parameters for updateShipmentTrackingDetails operation in FulfillmentInboundApi.
1881
- */
1882
- export interface FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest {
1883
- /**
1884
- * Identifier of an inbound plan.
1885
- */
1886
- readonly inboundPlanId: string;
1887
- /**
1888
- * Identifier of a shipment. A shipment contains the boxes and units being inbounded.
1889
- */
1890
- readonly shipmentId: string;
1891
- /**
1892
- * The body of the request to &#x60;updateShipmentTrackingDetails&#x60;.
1893
- */
1894
- readonly body: UpdateShipmentTrackingDetailsRequest;
1895
- }
1896
- /**
1897
- * FulfillmentInboundApi - object-oriented interface
1898
- */
1899
- export declare class FulfillmentInboundApi extends BaseAPI {
1900
- /**
1901
- * 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.
1902
- * @param {FulfillmentInboundApiCancelInboundPlanRequest} requestParameters Request parameters.
1903
- * @param {*} [options] Override http request option.
1904
- * @throws {RequiredError}
1905
- */
1906
- cancelInboundPlan(requestParameters: FulfillmentInboundApiCancelInboundPlanRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CancelInboundPlanResponse, any, {}>>;
1907
- /**
1908
- * Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
1909
- * @param {FulfillmentInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
1910
- * @param {*} [options] Override http request option.
1911
- * @throws {RequiredError}
1912
- */
1913
- cancelSelfShipAppointment(requestParameters: FulfillmentInboundApiCancelSelfShipAppointmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CancelSelfShipAppointmentResponse, any, {}>>;
1914
- /**
1915
- * Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation.
1916
- * @param {FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest} requestParameters Request parameters.
1917
- * @param {*} [options] Override http request option.
1918
- * @throws {RequiredError}
1919
- */
1920
- confirmDeliveryWindowOptions(requestParameters: FulfillmentInboundApiConfirmDeliveryWindowOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ConfirmDeliveryWindowOptionsResponse, any, {}>>;
1921
- /**
1922
- * Confirms the packing option for an inbound plan.
1923
- * @param {FulfillmentInboundApiConfirmPackingOptionRequest} requestParameters Request parameters.
1924
- * @param {*} [options] Override http request option.
1925
- * @throws {RequiredError}
1926
- */
1927
- confirmPackingOption(requestParameters: FulfillmentInboundApiConfirmPackingOptionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ConfirmPackingOptionResponse, any, {}>>;
1928
- /**
1929
- * Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan.
1930
- * @param {FulfillmentInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters.
1931
- * @param {*} [options] Override http request option.
1932
- * @throws {RequiredError}
1933
- */
1934
- confirmPlacementOption(requestParameters: FulfillmentInboundApiConfirmPlacementOptionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ConfirmPlacementOptionResponse, any, {}>>;
1935
- /**
1936
- * Confirm a shipment content update preview and accept the changes in transportation cost.
1937
- * @param {FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
1938
- * @param {*} [options] Override http request option.
1939
- * @throws {RequiredError}
1940
- */
1941
- confirmShipmentContentUpdatePreview(requestParameters: FulfillmentInboundApiConfirmShipmentContentUpdatePreviewRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ConfirmShipmentContentUpdatePreviewResponse, any, {}>>;
1942
- /**
1943
- * 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.
1944
- * @param {FulfillmentInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters.
1945
- * @param {*} [options] Override http request option.
1946
- * @throws {RequiredError}
1947
- */
1948
- confirmTransportationOptions(requestParameters: FulfillmentInboundApiConfirmTransportationOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ConfirmTransportationOptionsResponse, any, {}>>;
1949
- /**
1950
- * Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network.
1951
- * @param {FulfillmentInboundApiCreateInboundPlanRequest} requestParameters Request parameters.
1952
- * @param {*} [options] Override http request option.
1953
- * @throws {RequiredError}
1954
- */
1955
- createInboundPlan(requestParameters: FulfillmentInboundApiCreateInboundPlanRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInboundPlanResponse, any, {}>>;
1956
- /**
1957
- * For a given marketplace - creates labels for a list of MSKUs.
1958
- * @param {FulfillmentInboundApiCreateMarketplaceItemLabelsRequest} requestParameters Request parameters.
1959
- * @param {*} [options] Override http request option.
1960
- * @throws {RequiredError}
1961
- */
1962
- createMarketplaceItemLabels(requestParameters: FulfillmentInboundApiCreateMarketplaceItemLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateMarketplaceItemLabelsResponse, any, {}>>;
1963
- /**
1964
- * Generates available delivery window options for a given shipment.
1965
- * @param {FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest} requestParameters Request parameters.
1966
- * @param {*} [options] Override http request option.
1967
- * @throws {RequiredError}
1968
- */
1969
- generateDeliveryWindowOptions(requestParameters: FulfillmentInboundApiGenerateDeliveryWindowOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GenerateDeliveryWindowOptionsResponse, any, {}>>;
1970
- /**
1971
- * Generates available packing options for the inbound plan.
1972
- * @param {FulfillmentInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters.
1973
- * @param {*} [options] Override http request option.
1974
- * @throws {RequiredError}
1975
- */
1976
- generatePackingOptions(requestParameters: FulfillmentInboundApiGeneratePackingOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GeneratePackingOptionsResponse, any, {}>>;
1977
- /**
1978
- * Generates placement options for the inbound plan.
1979
- * @param {FulfillmentInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters.
1980
- * @param {*} [options] Override http request option.
1981
- * @throws {RequiredError}
1982
- */
1983
- generatePlacementOptions(requestParameters: FulfillmentInboundApiGeneratePlacementOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GeneratePlacementOptionsResponse, any, {}>>;
1984
- /**
1985
- * Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
1986
- * @param {FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
1987
- * @param {*} [options] Override http request option.
1988
- * @throws {RequiredError}
1989
- */
1990
- generateSelfShipAppointmentSlots(requestParameters: FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GenerateSelfShipAppointmentSlotsResponse, any, {}>>;
1991
- /**
1992
- * Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation.
1993
- * @param {FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
1994
- * @param {*} [options] Override http request option.
1995
- * @throws {RequiredError}
1996
- */
1997
- generateShipmentContentUpdatePreviews(requestParameters: FulfillmentInboundApiGenerateShipmentContentUpdatePreviewsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GenerateShipmentContentUpdatePreviewsResponse, any, {}>>;
1998
- /**
1999
- * Generates available transportation options for a given placement option.
2000
- * @param {FulfillmentInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters.
2001
- * @param {*} [options] Override http request option.
2002
- * @throws {RequiredError}
2003
- */
2004
- generateTransportationOptions(requestParameters: FulfillmentInboundApiGenerateTransportationOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GenerateTransportationOptionsResponse, any, {}>>;
2005
- /**
2006
- * Provide delivery challan document for PCP transportation in IN marketplace.
2007
- * @param {FulfillmentInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters.
2008
- * @param {*} [options] Override http request option.
2009
- * @throws {RequiredError}
2010
- */
2011
- getDeliveryChallanDocument(requestParameters: FulfillmentInboundApiGetDeliveryChallanDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDeliveryChallanDocumentResponse, any, {}>>;
2012
- /**
2013
- * Gets the status of the processing of an asynchronous API call.
2014
- * @param {FulfillmentInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters.
2015
- * @param {*} [options] Override http request option.
2016
- * @throws {RequiredError}
2017
- */
2018
- getInboundOperationStatus(requestParameters: FulfillmentInboundApiGetInboundOperationStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InboundOperationStatus, any, {}>>;
2019
- /**
2020
- * Fetches the top level information about an inbound plan.
2021
- * @param {FulfillmentInboundApiGetInboundPlanRequest} requestParameters Request parameters.
2022
- * @param {*} [options] Override http request option.
2023
- * @throws {RequiredError}
2024
- */
2025
- getInboundPlan(requestParameters: FulfillmentInboundApiGetInboundPlanRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InboundPlan, any, {}>>;
2026
- /**
2027
- * Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
2028
- * @param {FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
2029
- * @param {*} [options] Override http request option.
2030
- * @throws {RequiredError}
2031
- */
2032
- getSelfShipAppointmentSlots(requestParameters: FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetSelfShipAppointmentSlotsResponse, any, {}>>;
2033
- /**
2034
- * 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.
2035
- * @param {FulfillmentInboundApiGetShipmentRequest} requestParameters Request parameters.
2036
- * @param {*} [options] Override http request option.
2037
- * @throws {RequiredError}
2038
- */
2039
- getShipment(requestParameters: FulfillmentInboundApiGetShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Shipment, any, {}>>;
2040
- /**
2041
- * Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
2042
- * @param {FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
2043
- * @param {*} [options] Override http request option.
2044
- * @throws {RequiredError}
2045
- */
2046
- getShipmentContentUpdatePreview(requestParameters: FulfillmentInboundApiGetShipmentContentUpdatePreviewRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ContentUpdatePreview, any, {}>>;
2047
- /**
2048
- * Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available.
2049
- * @param {FulfillmentInboundApiListDeliveryWindowOptionsRequest} requestParameters Request parameters.
2050
- * @param {*} [options] Override http request option.
2051
- * @throws {RequiredError}
2052
- */
2053
- listDeliveryWindowOptions(requestParameters: FulfillmentInboundApiListDeliveryWindowOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListDeliveryWindowOptionsResponse, any, {}>>;
2054
- /**
2055
- * Provides a paginated list of box packages in an inbound plan.
2056
- * @param {FulfillmentInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters.
2057
- * @param {*} [options] Override http request option.
2058
- * @throws {RequiredError}
2059
- */
2060
- listInboundPlanBoxes(requestParameters: FulfillmentInboundApiListInboundPlanBoxesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListInboundPlanBoxesResponse, any, {}>>;
2061
- /**
2062
- * Provides a paginated list of item packages in an inbound plan.
2063
- * @param {FulfillmentInboundApiListInboundPlanItemsRequest} requestParameters Request parameters.
2064
- * @param {*} [options] Override http request option.
2065
- * @throws {RequiredError}
2066
- */
2067
- listInboundPlanItems(requestParameters: FulfillmentInboundApiListInboundPlanItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListInboundPlanItemsResponse, any, {}>>;
2068
- /**
2069
- * 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.
2070
- * @param {FulfillmentInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters.
2071
- * @param {*} [options] Override http request option.
2072
- * @throws {RequiredError}
2073
- */
2074
- listInboundPlanPallets(requestParameters: FulfillmentInboundApiListInboundPlanPalletsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListInboundPlanPalletsResponse, any, {}>>;
2075
- /**
2076
- * Provides a list of inbound plans with minimal information.
2077
- * @param {FulfillmentInboundApiListInboundPlansRequest} requestParameters Request parameters.
2078
- * @param {*} [options] Override http request option.
2079
- * @throws {RequiredError}
2080
- */
2081
- listInboundPlans(requestParameters?: FulfillmentInboundApiListInboundPlansRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListInboundPlansResponse, any, {}>>;
2082
- /**
2083
- * List the inbound compliance details for MSKUs in a given marketplace. **Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). The following characters must be double percent encoded: - `%` - `+` - `,` **Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
2084
- * @param {FulfillmentInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
2085
- * @param {*} [options] Override http request option.
2086
- * @throws {RequiredError}
2087
- */
2088
- listItemComplianceDetails(requestParameters: FulfillmentInboundApiListItemComplianceDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListItemComplianceDetailsResponse, any, {}>>;
2089
- /**
2090
- * Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits.
2091
- * @param {FulfillmentInboundApiListPackingGroupBoxesRequest} requestParameters Request parameters.
2092
- * @param {*} [options] Override http request option.
2093
- * @throws {RequiredError}
2094
- */
2095
- listPackingGroupBoxes(requestParameters: FulfillmentInboundApiListPackingGroupBoxesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListPackingGroupBoxesResponse, any, {}>>;
2096
- /**
2097
- * Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed.
2098
- * @param {FulfillmentInboundApiListPackingGroupItemsRequest} requestParameters Request parameters.
2099
- * @param {*} [options] Override http request option.
2100
- * @throws {RequiredError}
2101
- */
2102
- listPackingGroupItems(requestParameters: FulfillmentInboundApiListPackingGroupItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListPackingGroupItemsResponse, any, {}>>;
2103
- /**
2104
- * Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available.
2105
- * @param {FulfillmentInboundApiListPackingOptionsRequest} requestParameters Request parameters.
2106
- * @param {*} [options] Override http request option.
2107
- * @throws {RequiredError}
2108
- */
2109
- listPackingOptions(requestParameters: FulfillmentInboundApiListPackingOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListPackingOptionsResponse, any, {}>>;
2110
- /**
2111
- * Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available.
2112
- * @param {FulfillmentInboundApiListPlacementOptionsRequest} requestParameters Request parameters.
2113
- * @param {*} [options] Override http request option.
2114
- * @throws {RequiredError}
2115
- */
2116
- listPlacementOptions(requestParameters: FulfillmentInboundApiListPlacementOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListPlacementOptionsResponse, any, {}>>;
2117
- /**
2118
- * Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.
2119
- * @param {FulfillmentInboundApiListPrepDetailsRequest} requestParameters Request parameters.
2120
- * @param {*} [options] Override http request option.
2121
- * @throws {RequiredError}
2122
- */
2123
- listPrepDetails(requestParameters: FulfillmentInboundApiListPrepDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListPrepDetailsResponse, any, {}>>;
2124
- /**
2125
- * Provides a paginated list of box packages in a shipment.
2126
- * @param {FulfillmentInboundApiListShipmentBoxesRequest} requestParameters Request parameters.
2127
- * @param {*} [options] Override http request option.
2128
- * @throws {RequiredError}
2129
- */
2130
- listShipmentBoxes(requestParameters: FulfillmentInboundApiListShipmentBoxesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListShipmentBoxesResponse, any, {}>>;
2131
- /**
2132
- * Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified.
2133
- * @param {FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
2134
- * @param {*} [options] Override http request option.
2135
- * @throws {RequiredError}
2136
- */
2137
- listShipmentContentUpdatePreviews(requestParameters: FulfillmentInboundApiListShipmentContentUpdatePreviewsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListShipmentContentUpdatePreviewsResponse, any, {}>>;
2138
- /**
2139
- * Provides a paginated list of item packages in a shipment.
2140
- * @param {FulfillmentInboundApiListShipmentItemsRequest} requestParameters Request parameters.
2141
- * @param {*} [options] Override http request option.
2142
- * @throws {RequiredError}
2143
- */
2144
- listShipmentItems(requestParameters: FulfillmentInboundApiListShipmentItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListShipmentItemsResponse, any, {}>>;
2145
- /**
2146
- * Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments.
2147
- * @param {FulfillmentInboundApiListShipmentPalletsRequest} requestParameters Request parameters.
2148
- * @param {*} [options] Override http request option.
2149
- * @throws {RequiredError}
2150
- */
2151
- listShipmentPallets(requestParameters: FulfillmentInboundApiListShipmentPalletsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListShipmentPalletsResponse, any, {}>>;
2152
- /**
2153
- * Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available.
2154
- * @param {FulfillmentInboundApiListTransportationOptionsRequest} requestParameters Request parameters.
2155
- * @param {*} [options] Override http request option.
2156
- * @throws {RequiredError}
2157
- */
2158
- listTransportationOptions(requestParameters: FulfillmentInboundApiListTransportationOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListTransportationOptionsResponse, any, {}>>;
2159
- /**
2160
- * Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN.
2161
- * @param {FulfillmentInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
2162
- * @param {*} [options] Override http request option.
2163
- * @throws {RequiredError}
2164
- */
2165
- scheduleSelfShipAppointment(requestParameters: FulfillmentInboundApiScheduleSelfShipAppointmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ScheduleSelfShipAppointmentResponse, any, {}>>;
2166
- /**
2167
- * 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.
2168
- * @param {FulfillmentInboundApiSetPackingInformationRequest} requestParameters Request parameters.
2169
- * @param {*} [options] Override http request option.
2170
- * @throws {RequiredError}
2171
- */
2172
- setPackingInformation(requestParameters: FulfillmentInboundApiSetPackingInformationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SetPackingInformationResponse, any, {}>>;
2173
- /**
2174
- * Set the preparation details for a list of MSKUs in a specified marketplace.
2175
- * @param {FulfillmentInboundApiSetPrepDetailsRequest} requestParameters Request parameters.
2176
- * @param {*} [options] Override http request option.
2177
- * @throws {RequiredError}
2178
- */
2179
- setPrepDetails(requestParameters: FulfillmentInboundApiSetPrepDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SetPrepDetailsResponse, any, {}>>;
2180
- /**
2181
- * Updates the name of an existing inbound plan.
2182
- * @param {FulfillmentInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters.
2183
- * @param {*} [options] Override http request option.
2184
- * @throws {RequiredError}
2185
- */
2186
- updateInboundPlanName(requestParameters: FulfillmentInboundApiUpdateInboundPlanNameRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
2187
- /**
2188
- * Update compliance details for a list of MSKUs. The details provided here are only used for the India (IN - A21TJRUUN4KGV) marketplace compliance validation.
2189
- * @param {FulfillmentInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters.
2190
- * @param {*} [options] Override http request option.
2191
- * @throws {RequiredError}
2192
- */
2193
- updateItemComplianceDetails(requestParameters: FulfillmentInboundApiUpdateItemComplianceDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateItemComplianceDetailsResponse, any, {}>>;
2194
- /**
2195
- * Updates the name of an existing shipment.
2196
- * @param {FulfillmentInboundApiUpdateShipmentNameRequest} requestParameters Request parameters.
2197
- * @param {*} [options] Override http request option.
2198
- * @throws {RequiredError}
2199
- */
2200
- updateShipmentName(requestParameters: FulfillmentInboundApiUpdateShipmentNameRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
2201
- /**
2202
- * Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address.
2203
- * @param {FulfillmentInboundApiUpdateShipmentSourceAddressRequest} requestParameters Request parameters.
2204
- * @param {*} [options] Override http request option.
2205
- * @throws {RequiredError}
2206
- */
2207
- updateShipmentSourceAddress(requestParameters: FulfillmentInboundApiUpdateShipmentSourceAddressRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateShipmentSourceAddressResponse, any, {}>>;
2208
- /**
2209
- * Updates a shipment\'s tracking details.
2210
- * @param {FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters.
2211
- * @param {*} [options] Override http request option.
2212
- * @throws {RequiredError}
2213
- */
2214
- updateShipmentTrackingDetails(requestParameters: FulfillmentInboundApiUpdateShipmentTrackingDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateShipmentTrackingDetailsResponse, any, {}>>;
2215
- }
2216
- export declare const ListInboundPlansStatusEnum: {
2217
- readonly Active: "ACTIVE";
2218
- readonly Voided: "VOIDED";
2219
- readonly Shipped: "SHIPPED";
2220
- };
2221
- export type ListInboundPlansStatusEnum = typeof ListInboundPlansStatusEnum[keyof typeof ListInboundPlansStatusEnum];
2222
- export declare const ListInboundPlansSortByEnum: {
2223
- readonly LastUpdatedTime: "LAST_UPDATED_TIME";
2224
- readonly CreationTime: "CREATION_TIME";
2225
- };
2226
- export type ListInboundPlansSortByEnum = typeof ListInboundPlansSortByEnum[keyof typeof ListInboundPlansSortByEnum];
2227
- export declare const ListInboundPlansSortOrderEnum: {
2228
- readonly Asc: "ASC";
2229
- readonly Desc: "DESC";
2230
- };
2231
- export type ListInboundPlansSortOrderEnum = typeof ListInboundPlansSortOrderEnum[keyof typeof ListInboundPlansSortOrderEnum];