@sp-api-sdk/fulfillment-inbound-api-2024-03-20 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +97 -0
- package/dist/cjs/index.js +18 -0
- package/dist/cjs/src/api-model/api/fba-inbound-api.js +1968 -0
- package/dist/cjs/src/api-model/api.js +30 -0
- package/dist/cjs/src/api-model/base.js +66 -0
- package/dist/cjs/src/api-model/common.js +145 -0
- package/dist/cjs/src/api-model/configuration.js +91 -0
- package/dist/cjs/src/api-model/index.js +32 -0
- package/dist/cjs/src/api-model/models/address.js +15 -0
- package/dist/cjs/src/api-model/models/appointment-slot-time.js +15 -0
- package/dist/cjs/src/api-model/models/appointment-slot.js +15 -0
- package/dist/cjs/src/api-model/models/box-content-information-source.js +26 -0
- package/dist/cjs/src/api-model/models/box-content.js +15 -0
- package/dist/cjs/src/api-model/models/box-input.js +15 -0
- package/dist/cjs/src/api-model/models/box.js +15 -0
- package/dist/cjs/src/api-model/models/cancel-inbound-plan-response.js +15 -0
- package/dist/cjs/src/api-model/models/cancel-self-ship-appointment-request.js +15 -0
- package/dist/cjs/src/api-model/models/cancel-self-ship-appointment-response.js +15 -0
- package/dist/cjs/src/api-model/models/carrier.js +15 -0
- package/dist/cjs/src/api-model/models/compliance-detail.js +15 -0
- package/dist/cjs/src/api-model/models/confirm-packing-option-response.js +15 -0
- package/dist/cjs/src/api-model/models/confirm-placement-option-response.js +15 -0
- package/dist/cjs/src/api-model/models/confirm-transportation-options-request.js +15 -0
- package/dist/cjs/src/api-model/models/confirm-transportation-options-response.js +15 -0
- package/dist/cjs/src/api-model/models/contact-information.js +15 -0
- package/dist/cjs/src/api-model/models/create-inbound-plan-request.js +15 -0
- package/dist/cjs/src/api-model/models/create-inbound-plan-response.js +15 -0
- package/dist/cjs/src/api-model/models/currency.js +15 -0
- package/dist/cjs/src/api-model/models/custom-placement-input.js +15 -0
- package/dist/cjs/src/api-model/models/dates.js +15 -0
- package/dist/cjs/src/api-model/models/dimensions.js +15 -0
- package/dist/cjs/src/api-model/models/document-download.js +15 -0
- package/dist/cjs/src/api-model/models/error-list.js +15 -0
- package/dist/cjs/src/api-model/models/generate-packing-options-response.js +15 -0
- package/dist/cjs/src/api-model/models/generate-placement-options-request.js +15 -0
- package/dist/cjs/src/api-model/models/generate-placement-options-response.js +15 -0
- package/dist/cjs/src/api-model/models/generate-self-ship-appointment-slots-request.js +15 -0
- package/dist/cjs/src/api-model/models/generate-self-ship-appointment-slots-response.js +15 -0
- package/dist/cjs/src/api-model/models/generate-transportation-options-request.js +15 -0
- package/dist/cjs/src/api-model/models/generate-transportation-options-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-delivery-challan-document-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-self-ship-appointment-slots-response.js +15 -0
- package/dist/cjs/src/api-model/models/inbound-operation-status.js +15 -0
- package/dist/cjs/src/api-model/models/inbound-plan-summary.js +15 -0
- package/dist/cjs/src/api-model/models/inbound-plan.js +15 -0
- package/dist/cjs/src/api-model/models/incentive.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +119 -0
- package/dist/cjs/src/api-model/models/item-input.js +15 -0
- package/dist/cjs/src/api-model/models/item.js +15 -0
- package/dist/cjs/src/api-model/models/label-owner.js +25 -0
- package/dist/cjs/src/api-model/models/list-inbound-plan-boxes-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-inbound-plan-items-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-inbound-plan-pallets-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-inbound-plans-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-item-compliance-details-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-packing-group-items-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-packing-options-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-placement-options-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-transportation-options-response.js +15 -0
- package/dist/cjs/src/api-model/models/ltl-tracking-detail-input.js +15 -0
- package/dist/cjs/src/api-model/models/ltl-tracking-detail.js +15 -0
- package/dist/cjs/src/api-model/models/model-error.js +15 -0
- package/dist/cjs/src/api-model/models/operation-problem.js +15 -0
- package/dist/cjs/src/api-model/models/operation-status.js +26 -0
- package/dist/cjs/src/api-model/models/package-grouping-input.js +15 -0
- package/dist/cjs/src/api-model/models/packing-option-summary.js +15 -0
- package/dist/cjs/src/api-model/models/packing-option.js +15 -0
- package/dist/cjs/src/api-model/models/pagination.js +15 -0
- package/dist/cjs/src/api-model/models/pallet-information.js +15 -0
- package/dist/cjs/src/api-model/models/pallet-input.js +15 -0
- package/dist/cjs/src/api-model/models/pallet.js +15 -0
- package/dist/cjs/src/api-model/models/placement-option-summary.js +15 -0
- package/dist/cjs/src/api-model/models/placement-option.js +15 -0
- package/dist/cjs/src/api-model/models/prep-instruction.js +15 -0
- package/dist/cjs/src/api-model/models/prep-owner.js +25 -0
- package/dist/cjs/src/api-model/models/quote.js +15 -0
- package/dist/cjs/src/api-model/models/reason-comment.js +32 -0
- package/dist/cjs/src/api-model/models/region.js +15 -0
- package/dist/cjs/src/api-model/models/schedule-self-ship-appointment-request.js +15 -0
- package/dist/cjs/src/api-model/models/schedule-self-ship-appointment-response.js +15 -0
- package/dist/cjs/src/api-model/models/self-ship-appointment-details.js +15 -0
- package/dist/cjs/src/api-model/models/self-ship-appointment-slots-availability.js +15 -0
- package/dist/cjs/src/api-model/models/set-packing-information-request.js +15 -0
- package/dist/cjs/src/api-model/models/set-packing-information-response.js +15 -0
- package/dist/cjs/src/api-model/models/shipment-destination.js +15 -0
- package/dist/cjs/src/api-model/models/shipment-source.js +15 -0
- package/dist/cjs/src/api-model/models/shipment-summary.js +15 -0
- package/dist/cjs/src/api-model/models/shipment-transportation-configuration.js +15 -0
- package/dist/cjs/src/api-model/models/shipment.js +15 -0
- package/dist/cjs/src/api-model/models/shipping-configuration.js +15 -0
- package/dist/cjs/src/api-model/models/spd-tracking-detail-input.js +15 -0
- package/dist/cjs/src/api-model/models/spd-tracking-detail.js +15 -0
- package/dist/cjs/src/api-model/models/spd-tracking-item-input.js +15 -0
- package/dist/cjs/src/api-model/models/spd-tracking-item.js +15 -0
- package/dist/cjs/src/api-model/models/stackability.js +25 -0
- package/dist/cjs/src/api-model/models/tax-details.js +15 -0
- package/dist/cjs/src/api-model/models/tax-rate.js +15 -0
- package/dist/cjs/src/api-model/models/tracking-details-input.js +15 -0
- package/dist/cjs/src/api-model/models/tracking-details.js +15 -0
- package/dist/cjs/src/api-model/models/transportation-option.js +15 -0
- package/dist/cjs/src/api-model/models/transportation-selection.js +15 -0
- package/dist/cjs/src/api-model/models/unit-of-measurement.js +25 -0
- package/dist/cjs/src/api-model/models/unit-of-weight.js +25 -0
- package/dist/cjs/src/api-model/models/update-item-compliance-details-request.js +15 -0
- package/dist/cjs/src/api-model/models/update-item-compliance-details-response.js +15 -0
- package/dist/cjs/src/api-model/models/update-shipment-delivery-window-request.js +15 -0
- package/dist/cjs/src/api-model/models/update-shipment-delivery-window-response.js +15 -0
- package/dist/cjs/src/api-model/models/update-shipment-tracking-details-request.js +15 -0
- package/dist/cjs/src/api-model/models/update-shipment-tracking-details-response.js +15 -0
- package/dist/cjs/src/api-model/models/weight.js +15 -0
- package/dist/cjs/src/api-model/models/window-input.js +15 -0
- package/dist/cjs/src/api-model/models/window.js +15 -0
- package/dist/cjs/src/client.js +217 -0
- package/dist/es/index.js +2 -0
- package/dist/es/src/api-model/api/fba-inbound-api.js +1958 -0
- package/dist/es/src/api-model/api.js +14 -0
- package/dist/es/src/api-model/base.js +58 -0
- package/dist/es/src/api-model/common.js +133 -0
- package/dist/es/src/api-model/configuration.js +87 -0
- package/dist/es/src/api-model/index.js +16 -0
- package/dist/es/src/api-model/models/address.js +14 -0
- package/dist/es/src/api-model/models/appointment-slot-time.js +14 -0
- package/dist/es/src/api-model/models/appointment-slot.js +14 -0
- package/dist/es/src/api-model/models/box-content-information-source.js +23 -0
- package/dist/es/src/api-model/models/box-content.js +14 -0
- package/dist/es/src/api-model/models/box-input.js +14 -0
- package/dist/es/src/api-model/models/box.js +14 -0
- package/dist/es/src/api-model/models/cancel-inbound-plan-response.js +14 -0
- package/dist/es/src/api-model/models/cancel-self-ship-appointment-request.js +14 -0
- package/dist/es/src/api-model/models/cancel-self-ship-appointment-response.js +14 -0
- package/dist/es/src/api-model/models/carrier.js +14 -0
- package/dist/es/src/api-model/models/compliance-detail.js +14 -0
- package/dist/es/src/api-model/models/confirm-packing-option-response.js +14 -0
- package/dist/es/src/api-model/models/confirm-placement-option-response.js +14 -0
- package/dist/es/src/api-model/models/confirm-transportation-options-request.js +14 -0
- package/dist/es/src/api-model/models/confirm-transportation-options-response.js +14 -0
- package/dist/es/src/api-model/models/contact-information.js +14 -0
- package/dist/es/src/api-model/models/create-inbound-plan-request.js +14 -0
- package/dist/es/src/api-model/models/create-inbound-plan-response.js +14 -0
- package/dist/es/src/api-model/models/currency.js +14 -0
- package/dist/es/src/api-model/models/custom-placement-input.js +14 -0
- package/dist/es/src/api-model/models/dates.js +14 -0
- package/dist/es/src/api-model/models/dimensions.js +14 -0
- package/dist/es/src/api-model/models/document-download.js +14 -0
- package/dist/es/src/api-model/models/error-list.js +14 -0
- package/dist/es/src/api-model/models/generate-packing-options-response.js +14 -0
- package/dist/es/src/api-model/models/generate-placement-options-request.js +14 -0
- package/dist/es/src/api-model/models/generate-placement-options-response.js +14 -0
- package/dist/es/src/api-model/models/generate-self-ship-appointment-slots-request.js +14 -0
- package/dist/es/src/api-model/models/generate-self-ship-appointment-slots-response.js +14 -0
- package/dist/es/src/api-model/models/generate-transportation-options-request.js +14 -0
- package/dist/es/src/api-model/models/generate-transportation-options-response.js +14 -0
- package/dist/es/src/api-model/models/get-delivery-challan-document-response.js +14 -0
- package/dist/es/src/api-model/models/get-self-ship-appointment-slots-response.js +14 -0
- package/dist/es/src/api-model/models/inbound-operation-status.js +14 -0
- package/dist/es/src/api-model/models/inbound-plan-summary.js +14 -0
- package/dist/es/src/api-model/models/inbound-plan.js +14 -0
- package/dist/es/src/api-model/models/incentive.js +14 -0
- package/dist/es/src/api-model/models/index.js +103 -0
- package/dist/es/src/api-model/models/item-input.js +14 -0
- package/dist/es/src/api-model/models/item.js +14 -0
- package/dist/es/src/api-model/models/label-owner.js +22 -0
- package/dist/es/src/api-model/models/list-inbound-plan-boxes-response.js +14 -0
- package/dist/es/src/api-model/models/list-inbound-plan-items-response.js +14 -0
- package/dist/es/src/api-model/models/list-inbound-plan-pallets-response.js +14 -0
- package/dist/es/src/api-model/models/list-inbound-plans-response.js +14 -0
- package/dist/es/src/api-model/models/list-item-compliance-details-response.js +14 -0
- package/dist/es/src/api-model/models/list-packing-group-items-response.js +14 -0
- package/dist/es/src/api-model/models/list-packing-options-response.js +14 -0
- package/dist/es/src/api-model/models/list-placement-options-response.js +14 -0
- package/dist/es/src/api-model/models/list-transportation-options-response.js +14 -0
- package/dist/es/src/api-model/models/ltl-tracking-detail-input.js +14 -0
- package/dist/es/src/api-model/models/ltl-tracking-detail.js +14 -0
- package/dist/es/src/api-model/models/model-error.js +14 -0
- package/dist/es/src/api-model/models/operation-problem.js +14 -0
- package/dist/es/src/api-model/models/operation-status.js +23 -0
- package/dist/es/src/api-model/models/package-grouping-input.js +14 -0
- package/dist/es/src/api-model/models/packing-option-summary.js +14 -0
- package/dist/es/src/api-model/models/packing-option.js +14 -0
- package/dist/es/src/api-model/models/pagination.js +14 -0
- package/dist/es/src/api-model/models/pallet-information.js +14 -0
- package/dist/es/src/api-model/models/pallet-input.js +14 -0
- package/dist/es/src/api-model/models/pallet.js +14 -0
- package/dist/es/src/api-model/models/placement-option-summary.js +14 -0
- package/dist/es/src/api-model/models/placement-option.js +14 -0
- package/dist/es/src/api-model/models/prep-instruction.js +14 -0
- package/dist/es/src/api-model/models/prep-owner.js +22 -0
- package/dist/es/src/api-model/models/quote.js +14 -0
- package/dist/es/src/api-model/models/reason-comment.js +29 -0
- package/dist/es/src/api-model/models/region.js +14 -0
- package/dist/es/src/api-model/models/schedule-self-ship-appointment-request.js +14 -0
- package/dist/es/src/api-model/models/schedule-self-ship-appointment-response.js +14 -0
- package/dist/es/src/api-model/models/self-ship-appointment-details.js +14 -0
- package/dist/es/src/api-model/models/self-ship-appointment-slots-availability.js +14 -0
- package/dist/es/src/api-model/models/set-packing-information-request.js +14 -0
- package/dist/es/src/api-model/models/set-packing-information-response.js +14 -0
- package/dist/es/src/api-model/models/shipment-destination.js +14 -0
- package/dist/es/src/api-model/models/shipment-source.js +14 -0
- package/dist/es/src/api-model/models/shipment-summary.js +14 -0
- package/dist/es/src/api-model/models/shipment-transportation-configuration.js +14 -0
- package/dist/es/src/api-model/models/shipment.js +14 -0
- package/dist/es/src/api-model/models/shipping-configuration.js +14 -0
- package/dist/es/src/api-model/models/spd-tracking-detail-input.js +14 -0
- package/dist/es/src/api-model/models/spd-tracking-detail.js +14 -0
- package/dist/es/src/api-model/models/spd-tracking-item-input.js +14 -0
- package/dist/es/src/api-model/models/spd-tracking-item.js +14 -0
- package/dist/es/src/api-model/models/stackability.js +22 -0
- package/dist/es/src/api-model/models/tax-details.js +14 -0
- package/dist/es/src/api-model/models/tax-rate.js +14 -0
- package/dist/es/src/api-model/models/tracking-details-input.js +14 -0
- package/dist/es/src/api-model/models/tracking-details.js +14 -0
- package/dist/es/src/api-model/models/transportation-option.js +14 -0
- package/dist/es/src/api-model/models/transportation-selection.js +14 -0
- package/dist/es/src/api-model/models/unit-of-measurement.js +22 -0
- package/dist/es/src/api-model/models/unit-of-weight.js +22 -0
- package/dist/es/src/api-model/models/update-item-compliance-details-request.js +14 -0
- package/dist/es/src/api-model/models/update-item-compliance-details-response.js +14 -0
- package/dist/es/src/api-model/models/update-shipment-delivery-window-request.js +14 -0
- package/dist/es/src/api-model/models/update-shipment-delivery-window-response.js +14 -0
- package/dist/es/src/api-model/models/update-shipment-tracking-details-request.js +14 -0
- package/dist/es/src/api-model/models/update-shipment-tracking-details-response.js +14 -0
- package/dist/es/src/api-model/models/weight.js +14 -0
- package/dist/es/src/api-model/models/window-input.js +14 -0
- package/dist/es/src/api-model/models/window.js +14 -0
- package/dist/es/src/client.js +213 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/src/api-model/api/fba-inbound-api.d.ts +1675 -0
- package/dist/types/src/api-model/api.d.ts +12 -0
- package/dist/types/src/api-model/base.d.ts +54 -0
- package/dist/types/src/api-model/common.d.ts +66 -0
- package/dist/types/src/api-model/configuration.d.ts +83 -0
- package/dist/types/src/api-model/index.d.ts +14 -0
- package/dist/types/src/api-model/models/address.d.ts +66 -0
- package/dist/types/src/api-model/models/appointment-slot-time.d.ts +30 -0
- package/dist/types/src/api-model/models/appointment-slot.d.ts +31 -0
- package/dist/types/src/api-model/models/box-content-information-source.d.ts +22 -0
- package/dist/types/src/api-model/models/box-content.d.ts +56 -0
- package/dist/types/src/api-model/models/box-input.d.ts +64 -0
- package/dist/types/src/api-model/models/box.d.ts +70 -0
- package/dist/types/src/api-model/models/cancel-inbound-plan-response.d.ts +24 -0
- package/dist/types/src/api-model/models/cancel-self-ship-appointment-request.d.ts +25 -0
- package/dist/types/src/api-model/models/cancel-self-ship-appointment-response.d.ts +24 -0
- package/dist/types/src/api-model/models/carrier.d.ts +30 -0
- package/dist/types/src/api-model/models/compliance-detail.d.ts +43 -0
- package/dist/types/src/api-model/models/confirm-packing-option-response.d.ts +24 -0
- package/dist/types/src/api-model/models/confirm-placement-option-response.d.ts +24 -0
- package/dist/types/src/api-model/models/confirm-transportation-options-request.d.ts +25 -0
- package/dist/types/src/api-model/models/confirm-transportation-options-response.d.ts +24 -0
- package/dist/types/src/api-model/models/contact-information.d.ts +36 -0
- package/dist/types/src/api-model/models/create-inbound-plan-request.d.ts +51 -0
- package/dist/types/src/api-model/models/create-inbound-plan-response.d.ts +30 -0
- package/dist/types/src/api-model/models/currency.d.ts +30 -0
- package/dist/types/src/api-model/models/custom-placement-input.d.ts +31 -0
- package/dist/types/src/api-model/models/dates.d.ts +31 -0
- package/dist/types/src/api-model/models/dimensions.d.ts +43 -0
- package/dist/types/src/api-model/models/document-download.d.ts +36 -0
- package/dist/types/src/api-model/models/error-list.d.ts +24 -0
- package/dist/types/src/api-model/models/generate-packing-options-response.d.ts +24 -0
- package/dist/types/src/api-model/models/generate-placement-options-request.d.ts +25 -0
- package/dist/types/src/api-model/models/generate-placement-options-response.d.ts +24 -0
- package/dist/types/src/api-model/models/generate-self-ship-appointment-slots-request.d.ts +30 -0
- package/dist/types/src/api-model/models/generate-self-ship-appointment-slots-response.d.ts +24 -0
- package/dist/types/src/api-model/models/generate-transportation-options-request.d.ts +31 -0
- package/dist/types/src/api-model/models/generate-transportation-options-response.d.ts +24 -0
- package/dist/types/src/api-model/models/get-delivery-challan-document-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-self-ship-appointment-slots-response.d.ts +32 -0
- package/dist/types/src/api-model/models/inbound-operation-status.d.ts +44 -0
- package/dist/types/src/api-model/models/inbound-plan-summary.d.ts +68 -0
- package/dist/types/src/api-model/models/inbound-plan.d.ts +89 -0
- package/dist/types/src/api-model/models/incentive.d.ts +43 -0
- package/dist/types/src/api-model/models/index.d.ts +103 -0
- package/dist/types/src/api-model/models/item-input.d.ts +56 -0
- package/dist/types/src/api-model/models/item.d.ts +67 -0
- package/dist/types/src/api-model/models/label-owner.d.ts +21 -0
- package/dist/types/src/api-model/models/list-inbound-plan-boxes-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-inbound-plan-items-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-inbound-plan-pallets-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-inbound-plans-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-item-compliance-details-response.d.ts +25 -0
- package/dist/types/src/api-model/models/list-packing-group-items-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-packing-options-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-placement-options-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-transportation-options-response.d.ts +32 -0
- package/dist/types/src/api-model/models/ltl-tracking-detail-input.d.ts +30 -0
- package/dist/types/src/api-model/models/ltl-tracking-detail.d.ts +30 -0
- package/dist/types/src/api-model/models/model-error.d.ts +36 -0
- package/dist/types/src/api-model/models/operation-problem.d.ts +42 -0
- package/dist/types/src/api-model/models/operation-status.d.ts +22 -0
- package/dist/types/src/api-model/models/package-grouping-input.d.ts +37 -0
- package/dist/types/src/api-model/models/packing-option-summary.d.ts +30 -0
- package/dist/types/src/api-model/models/packing-option.d.ts +68 -0
- package/dist/types/src/api-model/models/pagination.d.ts +24 -0
- package/dist/types/src/api-model/models/pallet-information.d.ts +38 -0
- package/dist/types/src/api-model/models/pallet-input.d.ts +45 -0
- package/dist/types/src/api-model/models/pallet.d.ts +51 -0
- package/dist/types/src/api-model/models/placement-option-summary.d.ts +30 -0
- package/dist/types/src/api-model/models/placement-option.d.ts +55 -0
- package/dist/types/src/api-model/models/prep-instruction.d.ts +37 -0
- package/dist/types/src/api-model/models/prep-owner.d.ts +21 -0
- package/dist/types/src/api-model/models/quote.d.ts +37 -0
- package/dist/types/src/api-model/models/reason-comment.d.ts +28 -0
- package/dist/types/src/api-model/models/region.d.ts +36 -0
- package/dist/types/src/api-model/models/schedule-self-ship-appointment-request.d.ts +25 -0
- package/dist/types/src/api-model/models/schedule-self-ship-appointment-response.d.ts +25 -0
- package/dist/types/src/api-model/models/self-ship-appointment-details.d.ts +37 -0
- package/dist/types/src/api-model/models/self-ship-appointment-slots-availability.d.ts +31 -0
- package/dist/types/src/api-model/models/set-packing-information-request.d.ts +25 -0
- package/dist/types/src/api-model/models/set-packing-information-response.d.ts +24 -0
- package/dist/types/src/api-model/models/shipment-destination.d.ts +37 -0
- package/dist/types/src/api-model/models/shipment-source.d.ts +31 -0
- package/dist/types/src/api-model/models/shipment-summary.d.ts +30 -0
- package/dist/types/src/api-model/models/shipment-transportation-configuration.d.ts +45 -0
- package/dist/types/src/api-model/models/shipment.d.ts +115 -0
- package/dist/types/src/api-model/models/shipping-configuration.d.ts +30 -0
- package/dist/types/src/api-model/models/spd-tracking-detail-input.d.ts +25 -0
- package/dist/types/src/api-model/models/spd-tracking-detail.d.ts +25 -0
- package/dist/types/src/api-model/models/spd-tracking-item-input.d.ts +30 -0
- package/dist/types/src/api-model/models/spd-tracking-item.d.ts +36 -0
- package/dist/types/src/api-model/models/stackability.d.ts +21 -0
- package/dist/types/src/api-model/models/tax-details.d.ts +38 -0
- package/dist/types/src/api-model/models/tax-rate.d.ts +36 -0
- package/dist/types/src/api-model/models/tracking-details-input.d.ts +32 -0
- package/dist/types/src/api-model/models/tracking-details.d.ts +32 -0
- package/dist/types/src/api-model/models/transportation-option.d.ts +75 -0
- package/dist/types/src/api-model/models/transportation-selection.d.ts +44 -0
- package/dist/types/src/api-model/models/unit-of-measurement.d.ts +21 -0
- package/dist/types/src/api-model/models/unit-of-weight.d.ts +21 -0
- package/dist/types/src/api-model/models/update-item-compliance-details-request.d.ts +31 -0
- package/dist/types/src/api-model/models/update-item-compliance-details-response.d.ts +24 -0
- package/dist/types/src/api-model/models/update-shipment-delivery-window-request.d.ts +25 -0
- package/dist/types/src/api-model/models/update-shipment-delivery-window-response.d.ts +24 -0
- package/dist/types/src/api-model/models/update-shipment-tracking-details-request.d.ts +25 -0
- package/dist/types/src/api-model/models/update-shipment-tracking-details-response.d.ts +24 -0
- package/dist/types/src/api-model/models/weight.d.ts +31 -0
- package/dist/types/src/api-model/models/window-input.d.ts +24 -0
- package/dist/types/src/api-model/models/window.d.ts +36 -0
- package/dist/types/src/client.d.ts +6 -0
- package/package.json +44 -0
|
@@ -0,0 +1,1675 @@
|
|
|
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, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
16
|
+
import { CancelInboundPlanResponse } from '../models';
|
|
17
|
+
import { CancelSelfShipAppointmentRequest } from '../models';
|
|
18
|
+
import { CancelSelfShipAppointmentResponse } from '../models';
|
|
19
|
+
import { ConfirmPackingOptionResponse } from '../models';
|
|
20
|
+
import { ConfirmPlacementOptionResponse } from '../models';
|
|
21
|
+
import { ConfirmTransportationOptionsRequest } from '../models';
|
|
22
|
+
import { ConfirmTransportationOptionsResponse } from '../models';
|
|
23
|
+
import { CreateInboundPlanRequest } from '../models';
|
|
24
|
+
import { CreateInboundPlanResponse } from '../models';
|
|
25
|
+
import { GeneratePackingOptionsResponse } from '../models';
|
|
26
|
+
import { GeneratePlacementOptionsRequest } from '../models';
|
|
27
|
+
import { GeneratePlacementOptionsResponse } from '../models';
|
|
28
|
+
import { GenerateSelfShipAppointmentSlotsRequest } from '../models';
|
|
29
|
+
import { GenerateSelfShipAppointmentSlotsResponse } from '../models';
|
|
30
|
+
import { GenerateTransportationOptionsRequest } from '../models';
|
|
31
|
+
import { GenerateTransportationOptionsResponse } from '../models';
|
|
32
|
+
import { GetDeliveryChallanDocumentResponse } from '../models';
|
|
33
|
+
import { GetSelfShipAppointmentSlotsResponse } from '../models';
|
|
34
|
+
import { InboundOperationStatus } from '../models';
|
|
35
|
+
import { InboundPlan } from '../models';
|
|
36
|
+
import { ListInboundPlanBoxesResponse } from '../models';
|
|
37
|
+
import { ListInboundPlanItemsResponse } from '../models';
|
|
38
|
+
import { ListInboundPlanPalletsResponse } from '../models';
|
|
39
|
+
import { ListInboundPlansResponse } from '../models';
|
|
40
|
+
import { ListItemComplianceDetailsResponse } from '../models';
|
|
41
|
+
import { ListPackingGroupItemsResponse } from '../models';
|
|
42
|
+
import { ListPackingOptionsResponse } from '../models';
|
|
43
|
+
import { ListPlacementOptionsResponse } from '../models';
|
|
44
|
+
import { ListTransportationOptionsResponse } from '../models';
|
|
45
|
+
import { ScheduleSelfShipAppointmentRequest } from '../models';
|
|
46
|
+
import { ScheduleSelfShipAppointmentResponse } from '../models';
|
|
47
|
+
import { SetPackingInformationRequest } from '../models';
|
|
48
|
+
import { SetPackingInformationResponse } from '../models';
|
|
49
|
+
import { Shipment } from '../models';
|
|
50
|
+
import { UpdateItemComplianceDetailsRequest } from '../models';
|
|
51
|
+
import { UpdateItemComplianceDetailsResponse } from '../models';
|
|
52
|
+
import { UpdateShipmentDeliveryWindowRequest } from '../models';
|
|
53
|
+
import { UpdateShipmentDeliveryWindowResponse } from '../models';
|
|
54
|
+
import { UpdateShipmentTrackingDetailsRequest } from '../models';
|
|
55
|
+
import { UpdateShipmentTrackingDetailsResponse } from '../models';
|
|
56
|
+
/**
|
|
57
|
+
* FbaInboundApi - axios parameter creator
|
|
58
|
+
* @export
|
|
59
|
+
*/
|
|
60
|
+
export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
61
|
+
/**
|
|
62
|
+
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
63
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
cancelInboundPlan: (inboundPlanId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
|
+
/**
|
|
69
|
+
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
70
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
71
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
72
|
+
* @param {string} slotId Identifier to a self-ship appointment slot.
|
|
73
|
+
* @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
cancelSelfShipAppointment: (inboundPlanId: string, shipmentId: string, slotId: string, body: CancelSelfShipAppointmentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
|
+
/**
|
|
79
|
+
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
80
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
81
|
+
* @param {string} packingOptionId Identifier to a packing option.
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
confirmPackingOption: (inboundPlanId: string, packingOptionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
86
|
+
/**
|
|
87
|
+
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
88
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
89
|
+
* @param {string} placementOptionId Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs.
|
|
90
|
+
* @param {*} [options] Override http request option.
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
confirmPlacementOption: (inboundPlanId: string, placementOptionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
|
+
/**
|
|
95
|
+
* Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
96
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
97
|
+
* @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`.
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
*/
|
|
101
|
+
confirmTransportationOptions: (inboundPlanId: string, body: ConfirmTransportationOptionsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
102
|
+
/**
|
|
103
|
+
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
104
|
+
* @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`.
|
|
105
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
*/
|
|
108
|
+
createInboundPlan: (body: CreateInboundPlanRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
109
|
+
/**
|
|
110
|
+
* Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
111
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
112
|
+
* @param {*} [options] Override http request option.
|
|
113
|
+
* @throws {RequiredError}
|
|
114
|
+
*/
|
|
115
|
+
generatePackingOptions: (inboundPlanId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
116
|
+
/**
|
|
117
|
+
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
118
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
119
|
+
* @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`.
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
generatePlacementOptions: (inboundPlanId: string, body: GeneratePlacementOptionsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
124
|
+
/**
|
|
125
|
+
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
126
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
127
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
128
|
+
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request `generateSelfShipAppointmentSlots`.
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
*/
|
|
132
|
+
generateSelfShipAppointmentSlots: (inboundPlanId: string, shipmentId: string, body: GenerateSelfShipAppointmentSlotsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
133
|
+
/**
|
|
134
|
+
* Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
135
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
136
|
+
* @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`.
|
|
137
|
+
* @param {*} [options] Override http request option.
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
*/
|
|
140
|
+
generateTransportationOptions: (inboundPlanId: string, body: GenerateTransportationOptionsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
141
|
+
/**
|
|
142
|
+
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
143
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
144
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
145
|
+
* @param {*} [options] Override http request option.
|
|
146
|
+
* @throws {RequiredError}
|
|
147
|
+
*/
|
|
148
|
+
getDeliveryChallanDocument: (inboundPlanId: string, shipmentId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
149
|
+
/**
|
|
150
|
+
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
151
|
+
* @param {string} operationId Identifier to an asynchronous operation.
|
|
152
|
+
* @param {*} [options] Override http request option.
|
|
153
|
+
* @throws {RequiredError}
|
|
154
|
+
*/
|
|
155
|
+
getInboundOperationStatus: (operationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
156
|
+
/**
|
|
157
|
+
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
158
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
getInboundPlan: (inboundPlanId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
163
|
+
/**
|
|
164
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
165
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
166
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
167
|
+
* @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
|
|
168
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
169
|
+
* @param {*} [options] Override http request option.
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
getSelfShipAppointmentSlots: (inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
173
|
+
/**
|
|
174
|
+
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
175
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
176
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
177
|
+
* @param {*} [options] Override http request option.
|
|
178
|
+
* @throws {RequiredError}
|
|
179
|
+
*/
|
|
180
|
+
getShipment: (inboundPlanId: string, shipmentId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
181
|
+
/**
|
|
182
|
+
* Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
183
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
184
|
+
* @param {number} [pageSize] The number of boxes to return in the response matching the given query.
|
|
185
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
186
|
+
* @param {*} [options] Override http request option.
|
|
187
|
+
* @throws {RequiredError}
|
|
188
|
+
*/
|
|
189
|
+
listInboundPlanBoxes: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
190
|
+
/**
|
|
191
|
+
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
192
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
193
|
+
* @param {number} [pageSize] The number of items to return in the response matching the given query.
|
|
194
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
195
|
+
* @param {*} [options] Override http request option.
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
*/
|
|
198
|
+
listInboundPlanItems: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
199
|
+
/**
|
|
200
|
+
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
201
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
202
|
+
* @param {number} [pageSize] The number of pallets to return in the response matching the given query.
|
|
203
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
204
|
+
* @param {*} [options] Override http request option.
|
|
205
|
+
* @throws {RequiredError}
|
|
206
|
+
*/
|
|
207
|
+
listInboundPlanPallets: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
208
|
+
/**
|
|
209
|
+
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
210
|
+
* @param {number} [pageSize] The number of inbound plans to return in the response matching the given query.
|
|
211
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
212
|
+
* @param {'ACTIVE' | 'VOIDED' | 'SHIPPED'} [status] The status of an inbound plan.
|
|
213
|
+
* @param {'LAST_UPDATED_TIME' | 'CREATION_TIME'} [sortBy] Sort by field.
|
|
214
|
+
* @param {'ASC' | 'DESC'} [sortOrder] The sort order.
|
|
215
|
+
* @param {*} [options] Override http request option.
|
|
216
|
+
* @throws {RequiredError}
|
|
217
|
+
*/
|
|
218
|
+
listInboundPlans: (pageSize?: number, paginationToken?: string, status?: 'ACTIVE' | 'VOIDED' | 'SHIPPED', sortBy?: 'LAST_UPDATED_TIME' | 'CREATION_TIME', sortOrder?: 'ASC' | 'DESC', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
219
|
+
/**
|
|
220
|
+
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
221
|
+
* @param {Array<string>} mskus List of merchant SKUs, a merchant-supplied identifier for a specific SKU.
|
|
222
|
+
* @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
|
|
223
|
+
* @param {*} [options] Override http request option.
|
|
224
|
+
* @throws {RequiredError}
|
|
225
|
+
*/
|
|
226
|
+
listItemComplianceDetails: (mskus: Array<string>, marketplaceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
227
|
+
/**
|
|
228
|
+
* Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
229
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
230
|
+
* @param {string} packingOptionId Identifier to a packing option.
|
|
231
|
+
* @param {string} packingGroupId Identifier to a packing group.
|
|
232
|
+
* @param {number} [pageSize] The number of packing group items to return in the response matching the given query.
|
|
233
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
234
|
+
* @param {*} [options] Override http request option.
|
|
235
|
+
* @throws {RequiredError}
|
|
236
|
+
*/
|
|
237
|
+
listPackingGroupItems: (inboundPlanId: string, packingOptionId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
238
|
+
/**
|
|
239
|
+
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
240
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
241
|
+
* @param {number} [pageSize] The number of packing options to return in the response matching the given query.
|
|
242
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
243
|
+
* @param {*} [options] Override http request option.
|
|
244
|
+
* @throws {RequiredError}
|
|
245
|
+
*/
|
|
246
|
+
listPackingOptions: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
247
|
+
/**
|
|
248
|
+
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
249
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
250
|
+
* @param {number} [pageSize] The number of placement options to return in the response matching the given query.
|
|
251
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
252
|
+
* @param {*} [options] Override http request option.
|
|
253
|
+
* @throws {RequiredError}
|
|
254
|
+
*/
|
|
255
|
+
listPlacementOptions: (inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
256
|
+
/**
|
|
257
|
+
* Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
258
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
259
|
+
* @param {number} [pageSize] The number of transportation options to return in the response matching the given query.
|
|
260
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
261
|
+
* @param {string} [placementOptionId] The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
|
|
262
|
+
* @param {string} [shipmentId] The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
*/
|
|
266
|
+
listTransportationOptions: (inboundPlanId: string, pageSize?: number, paginationToken?: string, placementOptionId?: string, shipmentId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
267
|
+
/**
|
|
268
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
269
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
270
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
271
|
+
* @param {string} slotId Identifier to a self-ship appointment slot.
|
|
272
|
+
* @param {ScheduleSelfShipAppointmentRequest} body The body of the request to `scheduleSelfShipAppointment`.
|
|
273
|
+
* @param {*} [options] Override http request option.
|
|
274
|
+
* @throws {RequiredError}
|
|
275
|
+
*/
|
|
276
|
+
scheduleSelfShipAppointment: (inboundPlanId: string, shipmentId: string, slotId: string, body: ScheduleSelfShipAppointmentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
277
|
+
/**
|
|
278
|
+
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
279
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
280
|
+
* @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`.
|
|
281
|
+
* @param {*} [options] Override http request option.
|
|
282
|
+
* @throws {RequiredError}
|
|
283
|
+
*/
|
|
284
|
+
setPackingInformation: (inboundPlanId: string, body: SetPackingInformationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
285
|
+
/**
|
|
286
|
+
* Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
287
|
+
* @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
|
|
288
|
+
* @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`.
|
|
289
|
+
* @param {*} [options] Override http request option.
|
|
290
|
+
* @throws {RequiredError}
|
|
291
|
+
*/
|
|
292
|
+
updateItemComplianceDetails: (marketplaceId: string, body: UpdateItemComplianceDetailsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
293
|
+
/**
|
|
294
|
+
* Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
295
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
296
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
297
|
+
* @param {UpdateShipmentDeliveryWindowRequest} body The body of the request to `updateShipmentDeliveryWindow`.
|
|
298
|
+
* @param {*} [options] Override http request option.
|
|
299
|
+
* @throws {RequiredError}
|
|
300
|
+
*/
|
|
301
|
+
updateShipmentDeliveryWindow: (inboundPlanId: string, shipmentId: string, body: UpdateShipmentDeliveryWindowRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
302
|
+
/**
|
|
303
|
+
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
304
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
305
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
306
|
+
* @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`.
|
|
307
|
+
* @param {*} [options] Override http request option.
|
|
308
|
+
* @throws {RequiredError}
|
|
309
|
+
*/
|
|
310
|
+
updateShipmentTrackingDetails: (inboundPlanId: string, shipmentId: string, body: UpdateShipmentTrackingDetailsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
311
|
+
};
|
|
312
|
+
/**
|
|
313
|
+
* FbaInboundApi - functional programming interface
|
|
314
|
+
* @export
|
|
315
|
+
*/
|
|
316
|
+
export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
317
|
+
/**
|
|
318
|
+
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
319
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
320
|
+
* @param {*} [options] Override http request option.
|
|
321
|
+
* @throws {RequiredError}
|
|
322
|
+
*/
|
|
323
|
+
cancelInboundPlan(inboundPlanId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelInboundPlanResponse>>;
|
|
324
|
+
/**
|
|
325
|
+
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
326
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
327
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
328
|
+
* @param {string} slotId Identifier to a self-ship appointment slot.
|
|
329
|
+
* @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
|
|
330
|
+
* @param {*} [options] Override http request option.
|
|
331
|
+
* @throws {RequiredError}
|
|
332
|
+
*/
|
|
333
|
+
cancelSelfShipAppointment(inboundPlanId: string, shipmentId: string, slotId: string, body: CancelSelfShipAppointmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelSelfShipAppointmentResponse>>;
|
|
334
|
+
/**
|
|
335
|
+
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
336
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
337
|
+
* @param {string} packingOptionId Identifier to a packing option.
|
|
338
|
+
* @param {*} [options] Override http request option.
|
|
339
|
+
* @throws {RequiredError}
|
|
340
|
+
*/
|
|
341
|
+
confirmPackingOption(inboundPlanId: string, packingOptionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmPackingOptionResponse>>;
|
|
342
|
+
/**
|
|
343
|
+
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
344
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
345
|
+
* @param {string} placementOptionId Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs.
|
|
346
|
+
* @param {*} [options] Override http request option.
|
|
347
|
+
* @throws {RequiredError}
|
|
348
|
+
*/
|
|
349
|
+
confirmPlacementOption(inboundPlanId: string, placementOptionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmPlacementOptionResponse>>;
|
|
350
|
+
/**
|
|
351
|
+
* Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
352
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
353
|
+
* @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`.
|
|
354
|
+
* @param {*} [options] Override http request option.
|
|
355
|
+
* @throws {RequiredError}
|
|
356
|
+
*/
|
|
357
|
+
confirmTransportationOptions(inboundPlanId: string, body: ConfirmTransportationOptionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmTransportationOptionsResponse>>;
|
|
358
|
+
/**
|
|
359
|
+
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
360
|
+
* @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`.
|
|
361
|
+
* @param {*} [options] Override http request option.
|
|
362
|
+
* @throws {RequiredError}
|
|
363
|
+
*/
|
|
364
|
+
createInboundPlan(body: CreateInboundPlanRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInboundPlanResponse>>;
|
|
365
|
+
/**
|
|
366
|
+
* Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
367
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
368
|
+
* @param {*} [options] Override http request option.
|
|
369
|
+
* @throws {RequiredError}
|
|
370
|
+
*/
|
|
371
|
+
generatePackingOptions(inboundPlanId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneratePackingOptionsResponse>>;
|
|
372
|
+
/**
|
|
373
|
+
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
374
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
375
|
+
* @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`.
|
|
376
|
+
* @param {*} [options] Override http request option.
|
|
377
|
+
* @throws {RequiredError}
|
|
378
|
+
*/
|
|
379
|
+
generatePlacementOptions(inboundPlanId: string, body: GeneratePlacementOptionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GeneratePlacementOptionsResponse>>;
|
|
380
|
+
/**
|
|
381
|
+
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
382
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
383
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
384
|
+
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request `generateSelfShipAppointmentSlots`.
|
|
385
|
+
* @param {*} [options] Override http request option.
|
|
386
|
+
* @throws {RequiredError}
|
|
387
|
+
*/
|
|
388
|
+
generateSelfShipAppointmentSlots(inboundPlanId: string, shipmentId: string, body: GenerateSelfShipAppointmentSlotsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>>;
|
|
389
|
+
/**
|
|
390
|
+
* Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
391
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
392
|
+
* @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`.
|
|
393
|
+
* @param {*} [options] Override http request option.
|
|
394
|
+
* @throws {RequiredError}
|
|
395
|
+
*/
|
|
396
|
+
generateTransportationOptions(inboundPlanId: string, body: GenerateTransportationOptionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateTransportationOptionsResponse>>;
|
|
397
|
+
/**
|
|
398
|
+
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
399
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
400
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
401
|
+
* @param {*} [options] Override http request option.
|
|
402
|
+
* @throws {RequiredError}
|
|
403
|
+
*/
|
|
404
|
+
getDeliveryChallanDocument(inboundPlanId: string, shipmentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDeliveryChallanDocumentResponse>>;
|
|
405
|
+
/**
|
|
406
|
+
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
407
|
+
* @param {string} operationId Identifier to an asynchronous operation.
|
|
408
|
+
* @param {*} [options] Override http request option.
|
|
409
|
+
* @throws {RequiredError}
|
|
410
|
+
*/
|
|
411
|
+
getInboundOperationStatus(operationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundOperationStatus>>;
|
|
412
|
+
/**
|
|
413
|
+
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
414
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
415
|
+
* @param {*} [options] Override http request option.
|
|
416
|
+
* @throws {RequiredError}
|
|
417
|
+
*/
|
|
418
|
+
getInboundPlan(inboundPlanId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundPlan>>;
|
|
419
|
+
/**
|
|
420
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
421
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
422
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
423
|
+
* @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
|
|
424
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
425
|
+
* @param {*} [options] Override http request option.
|
|
426
|
+
* @throws {RequiredError}
|
|
427
|
+
*/
|
|
428
|
+
getSelfShipAppointmentSlots(inboundPlanId: string, shipmentId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSelfShipAppointmentSlotsResponse>>;
|
|
429
|
+
/**
|
|
430
|
+
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
431
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
432
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
433
|
+
* @param {*} [options] Override http request option.
|
|
434
|
+
* @throws {RequiredError}
|
|
435
|
+
*/
|
|
436
|
+
getShipment(inboundPlanId: string, shipmentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>>;
|
|
437
|
+
/**
|
|
438
|
+
* Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
439
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
440
|
+
* @param {number} [pageSize] The number of boxes to return in the response matching the given query.
|
|
441
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
442
|
+
* @param {*} [options] Override http request option.
|
|
443
|
+
* @throws {RequiredError}
|
|
444
|
+
*/
|
|
445
|
+
listInboundPlanBoxes(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInboundPlanBoxesResponse>>;
|
|
446
|
+
/**
|
|
447
|
+
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
448
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
449
|
+
* @param {number} [pageSize] The number of items to return in the response matching the given query.
|
|
450
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
451
|
+
* @param {*} [options] Override http request option.
|
|
452
|
+
* @throws {RequiredError}
|
|
453
|
+
*/
|
|
454
|
+
listInboundPlanItems(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInboundPlanItemsResponse>>;
|
|
455
|
+
/**
|
|
456
|
+
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
457
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
458
|
+
* @param {number} [pageSize] The number of pallets to return in the response matching the given query.
|
|
459
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
460
|
+
* @param {*} [options] Override http request option.
|
|
461
|
+
* @throws {RequiredError}
|
|
462
|
+
*/
|
|
463
|
+
listInboundPlanPallets(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInboundPlanPalletsResponse>>;
|
|
464
|
+
/**
|
|
465
|
+
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
466
|
+
* @param {number} [pageSize] The number of inbound plans to return in the response matching the given query.
|
|
467
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
468
|
+
* @param {'ACTIVE' | 'VOIDED' | 'SHIPPED'} [status] The status of an inbound plan.
|
|
469
|
+
* @param {'LAST_UPDATED_TIME' | 'CREATION_TIME'} [sortBy] Sort by field.
|
|
470
|
+
* @param {'ASC' | 'DESC'} [sortOrder] The sort order.
|
|
471
|
+
* @param {*} [options] Override http request option.
|
|
472
|
+
* @throws {RequiredError}
|
|
473
|
+
*/
|
|
474
|
+
listInboundPlans(pageSize?: number, paginationToken?: string, status?: 'ACTIVE' | 'VOIDED' | 'SHIPPED', sortBy?: 'LAST_UPDATED_TIME' | 'CREATION_TIME', sortOrder?: 'ASC' | 'DESC', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInboundPlansResponse>>;
|
|
475
|
+
/**
|
|
476
|
+
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
477
|
+
* @param {Array<string>} mskus List of merchant SKUs, a merchant-supplied identifier for a specific SKU.
|
|
478
|
+
* @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
|
|
479
|
+
* @param {*} [options] Override http request option.
|
|
480
|
+
* @throws {RequiredError}
|
|
481
|
+
*/
|
|
482
|
+
listItemComplianceDetails(mskus: Array<string>, marketplaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListItemComplianceDetailsResponse>>;
|
|
483
|
+
/**
|
|
484
|
+
* Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
485
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
486
|
+
* @param {string} packingOptionId Identifier to a packing option.
|
|
487
|
+
* @param {string} packingGroupId Identifier to a packing group.
|
|
488
|
+
* @param {number} [pageSize] The number of packing group items to return in the response matching the given query.
|
|
489
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
490
|
+
* @param {*} [options] Override http request option.
|
|
491
|
+
* @throws {RequiredError}
|
|
492
|
+
*/
|
|
493
|
+
listPackingGroupItems(inboundPlanId: string, packingOptionId: string, packingGroupId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPackingGroupItemsResponse>>;
|
|
494
|
+
/**
|
|
495
|
+
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
496
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
497
|
+
* @param {number} [pageSize] The number of packing options to return in the response matching the given query.
|
|
498
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
499
|
+
* @param {*} [options] Override http request option.
|
|
500
|
+
* @throws {RequiredError}
|
|
501
|
+
*/
|
|
502
|
+
listPackingOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPackingOptionsResponse>>;
|
|
503
|
+
/**
|
|
504
|
+
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
505
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
506
|
+
* @param {number} [pageSize] The number of placement options to return in the response matching the given query.
|
|
507
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
508
|
+
* @param {*} [options] Override http request option.
|
|
509
|
+
* @throws {RequiredError}
|
|
510
|
+
*/
|
|
511
|
+
listPlacementOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPlacementOptionsResponse>>;
|
|
512
|
+
/**
|
|
513
|
+
* Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
514
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
515
|
+
* @param {number} [pageSize] The number of transportation options to return in the response matching the given query.
|
|
516
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
517
|
+
* @param {string} [placementOptionId] The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
|
|
518
|
+
* @param {string} [shipmentId] The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
|
|
519
|
+
* @param {*} [options] Override http request option.
|
|
520
|
+
* @throws {RequiredError}
|
|
521
|
+
*/
|
|
522
|
+
listTransportationOptions(inboundPlanId: string, pageSize?: number, paginationToken?: string, placementOptionId?: string, shipmentId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransportationOptionsResponse>>;
|
|
523
|
+
/**
|
|
524
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
525
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
526
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
527
|
+
* @param {string} slotId Identifier to a self-ship appointment slot.
|
|
528
|
+
* @param {ScheduleSelfShipAppointmentRequest} body The body of the request to `scheduleSelfShipAppointment`.
|
|
529
|
+
* @param {*} [options] Override http request option.
|
|
530
|
+
* @throws {RequiredError}
|
|
531
|
+
*/
|
|
532
|
+
scheduleSelfShipAppointment(inboundPlanId: string, shipmentId: string, slotId: string, body: ScheduleSelfShipAppointmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScheduleSelfShipAppointmentResponse>>;
|
|
533
|
+
/**
|
|
534
|
+
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
535
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
536
|
+
* @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`.
|
|
537
|
+
* @param {*} [options] Override http request option.
|
|
538
|
+
* @throws {RequiredError}
|
|
539
|
+
*/
|
|
540
|
+
setPackingInformation(inboundPlanId: string, body: SetPackingInformationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetPackingInformationResponse>>;
|
|
541
|
+
/**
|
|
542
|
+
* Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
543
|
+
* @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
|
|
544
|
+
* @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`.
|
|
545
|
+
* @param {*} [options] Override http request option.
|
|
546
|
+
* @throws {RequiredError}
|
|
547
|
+
*/
|
|
548
|
+
updateItemComplianceDetails(marketplaceId: string, body: UpdateItemComplianceDetailsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateItemComplianceDetailsResponse>>;
|
|
549
|
+
/**
|
|
550
|
+
* Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
551
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
552
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
553
|
+
* @param {UpdateShipmentDeliveryWindowRequest} body The body of the request to `updateShipmentDeliveryWindow`.
|
|
554
|
+
* @param {*} [options] Override http request option.
|
|
555
|
+
* @throws {RequiredError}
|
|
556
|
+
*/
|
|
557
|
+
updateShipmentDeliveryWindow(inboundPlanId: string, shipmentId: string, body: UpdateShipmentDeliveryWindowRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateShipmentDeliveryWindowResponse>>;
|
|
558
|
+
/**
|
|
559
|
+
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
560
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
561
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
562
|
+
* @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`.
|
|
563
|
+
* @param {*} [options] Override http request option.
|
|
564
|
+
* @throws {RequiredError}
|
|
565
|
+
*/
|
|
566
|
+
updateShipmentTrackingDetails(inboundPlanId: string, shipmentId: string, body: UpdateShipmentTrackingDetailsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateShipmentTrackingDetailsResponse>>;
|
|
567
|
+
};
|
|
568
|
+
/**
|
|
569
|
+
* FbaInboundApi - factory interface
|
|
570
|
+
* @export
|
|
571
|
+
*/
|
|
572
|
+
export declare const FbaInboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
573
|
+
/**
|
|
574
|
+
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
575
|
+
* @param {FbaInboundApiCancelInboundPlanRequest} requestParameters Request parameters.
|
|
576
|
+
* @param {*} [options] Override http request option.
|
|
577
|
+
* @throws {RequiredError}
|
|
578
|
+
*/
|
|
579
|
+
cancelInboundPlan(requestParameters: FbaInboundApiCancelInboundPlanRequest, options?: AxiosRequestConfig): AxiosPromise<CancelInboundPlanResponse>;
|
|
580
|
+
/**
|
|
581
|
+
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
582
|
+
* @param {FbaInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
583
|
+
* @param {*} [options] Override http request option.
|
|
584
|
+
* @throws {RequiredError}
|
|
585
|
+
*/
|
|
586
|
+
cancelSelfShipAppointment(requestParameters: FbaInboundApiCancelSelfShipAppointmentRequest, options?: AxiosRequestConfig): AxiosPromise<CancelSelfShipAppointmentResponse>;
|
|
587
|
+
/**
|
|
588
|
+
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
589
|
+
* @param {FbaInboundApiConfirmPackingOptionRequest} requestParameters Request parameters.
|
|
590
|
+
* @param {*} [options] Override http request option.
|
|
591
|
+
* @throws {RequiredError}
|
|
592
|
+
*/
|
|
593
|
+
confirmPackingOption(requestParameters: FbaInboundApiConfirmPackingOptionRequest, options?: AxiosRequestConfig): AxiosPromise<ConfirmPackingOptionResponse>;
|
|
594
|
+
/**
|
|
595
|
+
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
596
|
+
* @param {FbaInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters.
|
|
597
|
+
* @param {*} [options] Override http request option.
|
|
598
|
+
* @throws {RequiredError}
|
|
599
|
+
*/
|
|
600
|
+
confirmPlacementOption(requestParameters: FbaInboundApiConfirmPlacementOptionRequest, options?: AxiosRequestConfig): AxiosPromise<ConfirmPlacementOptionResponse>;
|
|
601
|
+
/**
|
|
602
|
+
* Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
603
|
+
* @param {FbaInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters.
|
|
604
|
+
* @param {*} [options] Override http request option.
|
|
605
|
+
* @throws {RequiredError}
|
|
606
|
+
*/
|
|
607
|
+
confirmTransportationOptions(requestParameters: FbaInboundApiConfirmTransportationOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<ConfirmTransportationOptionsResponse>;
|
|
608
|
+
/**
|
|
609
|
+
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
610
|
+
* @param {FbaInboundApiCreateInboundPlanRequest} requestParameters Request parameters.
|
|
611
|
+
* @param {*} [options] Override http request option.
|
|
612
|
+
* @throws {RequiredError}
|
|
613
|
+
*/
|
|
614
|
+
createInboundPlan(requestParameters: FbaInboundApiCreateInboundPlanRequest, options?: AxiosRequestConfig): AxiosPromise<CreateInboundPlanResponse>;
|
|
615
|
+
/**
|
|
616
|
+
* Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
617
|
+
* @param {FbaInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters.
|
|
618
|
+
* @param {*} [options] Override http request option.
|
|
619
|
+
* @throws {RequiredError}
|
|
620
|
+
*/
|
|
621
|
+
generatePackingOptions(requestParameters: FbaInboundApiGeneratePackingOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<GeneratePackingOptionsResponse>;
|
|
622
|
+
/**
|
|
623
|
+
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
624
|
+
* @param {FbaInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters.
|
|
625
|
+
* @param {*} [options] Override http request option.
|
|
626
|
+
* @throws {RequiredError}
|
|
627
|
+
*/
|
|
628
|
+
generatePlacementOptions(requestParameters: FbaInboundApiGeneratePlacementOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<GeneratePlacementOptionsResponse>;
|
|
629
|
+
/**
|
|
630
|
+
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
631
|
+
* @param {FbaInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
632
|
+
* @param {*} [options] Override http request option.
|
|
633
|
+
* @throws {RequiredError}
|
|
634
|
+
*/
|
|
635
|
+
generateSelfShipAppointmentSlots(requestParameters: FbaInboundApiGenerateSelfShipAppointmentSlotsRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateSelfShipAppointmentSlotsResponse>;
|
|
636
|
+
/**
|
|
637
|
+
* Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
638
|
+
* @param {FbaInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters.
|
|
639
|
+
* @param {*} [options] Override http request option.
|
|
640
|
+
* @throws {RequiredError}
|
|
641
|
+
*/
|
|
642
|
+
generateTransportationOptions(requestParameters: FbaInboundApiGenerateTransportationOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateTransportationOptionsResponse>;
|
|
643
|
+
/**
|
|
644
|
+
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
645
|
+
* @param {FbaInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters.
|
|
646
|
+
* @param {*} [options] Override http request option.
|
|
647
|
+
* @throws {RequiredError}
|
|
648
|
+
*/
|
|
649
|
+
getDeliveryChallanDocument(requestParameters: FbaInboundApiGetDeliveryChallanDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<GetDeliveryChallanDocumentResponse>;
|
|
650
|
+
/**
|
|
651
|
+
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
652
|
+
* @param {FbaInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters.
|
|
653
|
+
* @param {*} [options] Override http request option.
|
|
654
|
+
* @throws {RequiredError}
|
|
655
|
+
*/
|
|
656
|
+
getInboundOperationStatus(requestParameters: FbaInboundApiGetInboundOperationStatusRequest, options?: AxiosRequestConfig): AxiosPromise<InboundOperationStatus>;
|
|
657
|
+
/**
|
|
658
|
+
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
659
|
+
* @param {FbaInboundApiGetInboundPlanRequest} requestParameters Request parameters.
|
|
660
|
+
* @param {*} [options] Override http request option.
|
|
661
|
+
* @throws {RequiredError}
|
|
662
|
+
*/
|
|
663
|
+
getInboundPlan(requestParameters: FbaInboundApiGetInboundPlanRequest, options?: AxiosRequestConfig): AxiosPromise<InboundPlan>;
|
|
664
|
+
/**
|
|
665
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
666
|
+
* @param {FbaInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
667
|
+
* @param {*} [options] Override http request option.
|
|
668
|
+
* @throws {RequiredError}
|
|
669
|
+
*/
|
|
670
|
+
getSelfShipAppointmentSlots(requestParameters: FbaInboundApiGetSelfShipAppointmentSlotsRequest, options?: AxiosRequestConfig): AxiosPromise<GetSelfShipAppointmentSlotsResponse>;
|
|
671
|
+
/**
|
|
672
|
+
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
673
|
+
* @param {FbaInboundApiGetShipmentRequest} requestParameters Request parameters.
|
|
674
|
+
* @param {*} [options] Override http request option.
|
|
675
|
+
* @throws {RequiredError}
|
|
676
|
+
*/
|
|
677
|
+
getShipment(requestParameters: FbaInboundApiGetShipmentRequest, options?: AxiosRequestConfig): AxiosPromise<Shipment>;
|
|
678
|
+
/**
|
|
679
|
+
* Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
680
|
+
* @param {FbaInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters.
|
|
681
|
+
* @param {*} [options] Override http request option.
|
|
682
|
+
* @throws {RequiredError}
|
|
683
|
+
*/
|
|
684
|
+
listInboundPlanBoxes(requestParameters: FbaInboundApiListInboundPlanBoxesRequest, options?: AxiosRequestConfig): AxiosPromise<ListInboundPlanBoxesResponse>;
|
|
685
|
+
/**
|
|
686
|
+
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
687
|
+
* @param {FbaInboundApiListInboundPlanItemsRequest} requestParameters Request parameters.
|
|
688
|
+
* @param {*} [options] Override http request option.
|
|
689
|
+
* @throws {RequiredError}
|
|
690
|
+
*/
|
|
691
|
+
listInboundPlanItems(requestParameters: FbaInboundApiListInboundPlanItemsRequest, options?: AxiosRequestConfig): AxiosPromise<ListInboundPlanItemsResponse>;
|
|
692
|
+
/**
|
|
693
|
+
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
694
|
+
* @param {FbaInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters.
|
|
695
|
+
* @param {*} [options] Override http request option.
|
|
696
|
+
* @throws {RequiredError}
|
|
697
|
+
*/
|
|
698
|
+
listInboundPlanPallets(requestParameters: FbaInboundApiListInboundPlanPalletsRequest, options?: AxiosRequestConfig): AxiosPromise<ListInboundPlanPalletsResponse>;
|
|
699
|
+
/**
|
|
700
|
+
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
701
|
+
* @param {FbaInboundApiListInboundPlansRequest} requestParameters Request parameters.
|
|
702
|
+
* @param {*} [options] Override http request option.
|
|
703
|
+
* @throws {RequiredError}
|
|
704
|
+
*/
|
|
705
|
+
listInboundPlans(requestParameters?: FbaInboundApiListInboundPlansRequest, options?: AxiosRequestConfig): AxiosPromise<ListInboundPlansResponse>;
|
|
706
|
+
/**
|
|
707
|
+
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
708
|
+
* @param {FbaInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
709
|
+
* @param {*} [options] Override http request option.
|
|
710
|
+
* @throws {RequiredError}
|
|
711
|
+
*/
|
|
712
|
+
listItemComplianceDetails(requestParameters: FbaInboundApiListItemComplianceDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<ListItemComplianceDetailsResponse>;
|
|
713
|
+
/**
|
|
714
|
+
* Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
715
|
+
* @param {FbaInboundApiListPackingGroupItemsRequest} requestParameters Request parameters.
|
|
716
|
+
* @param {*} [options] Override http request option.
|
|
717
|
+
* @throws {RequiredError}
|
|
718
|
+
*/
|
|
719
|
+
listPackingGroupItems(requestParameters: FbaInboundApiListPackingGroupItemsRequest, options?: AxiosRequestConfig): AxiosPromise<ListPackingGroupItemsResponse>;
|
|
720
|
+
/**
|
|
721
|
+
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
722
|
+
* @param {FbaInboundApiListPackingOptionsRequest} requestParameters Request parameters.
|
|
723
|
+
* @param {*} [options] Override http request option.
|
|
724
|
+
* @throws {RequiredError}
|
|
725
|
+
*/
|
|
726
|
+
listPackingOptions(requestParameters: FbaInboundApiListPackingOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<ListPackingOptionsResponse>;
|
|
727
|
+
/**
|
|
728
|
+
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
729
|
+
* @param {FbaInboundApiListPlacementOptionsRequest} requestParameters Request parameters.
|
|
730
|
+
* @param {*} [options] Override http request option.
|
|
731
|
+
* @throws {RequiredError}
|
|
732
|
+
*/
|
|
733
|
+
listPlacementOptions(requestParameters: FbaInboundApiListPlacementOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<ListPlacementOptionsResponse>;
|
|
734
|
+
/**
|
|
735
|
+
* Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
736
|
+
* @param {FbaInboundApiListTransportationOptionsRequest} requestParameters Request parameters.
|
|
737
|
+
* @param {*} [options] Override http request option.
|
|
738
|
+
* @throws {RequiredError}
|
|
739
|
+
*/
|
|
740
|
+
listTransportationOptions(requestParameters: FbaInboundApiListTransportationOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<ListTransportationOptionsResponse>;
|
|
741
|
+
/**
|
|
742
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
743
|
+
* @param {FbaInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
744
|
+
* @param {*} [options] Override http request option.
|
|
745
|
+
* @throws {RequiredError}
|
|
746
|
+
*/
|
|
747
|
+
scheduleSelfShipAppointment(requestParameters: FbaInboundApiScheduleSelfShipAppointmentRequest, options?: AxiosRequestConfig): AxiosPromise<ScheduleSelfShipAppointmentResponse>;
|
|
748
|
+
/**
|
|
749
|
+
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
750
|
+
* @param {FbaInboundApiSetPackingInformationRequest} requestParameters Request parameters.
|
|
751
|
+
* @param {*} [options] Override http request option.
|
|
752
|
+
* @throws {RequiredError}
|
|
753
|
+
*/
|
|
754
|
+
setPackingInformation(requestParameters: FbaInboundApiSetPackingInformationRequest, options?: AxiosRequestConfig): AxiosPromise<SetPackingInformationResponse>;
|
|
755
|
+
/**
|
|
756
|
+
* Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
757
|
+
* @param {FbaInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
758
|
+
* @param {*} [options] Override http request option.
|
|
759
|
+
* @throws {RequiredError}
|
|
760
|
+
*/
|
|
761
|
+
updateItemComplianceDetails(requestParameters: FbaInboundApiUpdateItemComplianceDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateItemComplianceDetailsResponse>;
|
|
762
|
+
/**
|
|
763
|
+
* Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
764
|
+
* @param {FbaInboundApiUpdateShipmentDeliveryWindowRequest} requestParameters Request parameters.
|
|
765
|
+
* @param {*} [options] Override http request option.
|
|
766
|
+
* @throws {RequiredError}
|
|
767
|
+
*/
|
|
768
|
+
updateShipmentDeliveryWindow(requestParameters: FbaInboundApiUpdateShipmentDeliveryWindowRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateShipmentDeliveryWindowResponse>;
|
|
769
|
+
/**
|
|
770
|
+
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
771
|
+
* @param {FbaInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters.
|
|
772
|
+
* @param {*} [options] Override http request option.
|
|
773
|
+
* @throws {RequiredError}
|
|
774
|
+
*/
|
|
775
|
+
updateShipmentTrackingDetails(requestParameters: FbaInboundApiUpdateShipmentTrackingDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateShipmentTrackingDetailsResponse>;
|
|
776
|
+
};
|
|
777
|
+
/**
|
|
778
|
+
* Request parameters for cancelInboundPlan operation in FbaInboundApi.
|
|
779
|
+
* @export
|
|
780
|
+
* @interface FbaInboundApiCancelInboundPlanRequest
|
|
781
|
+
*/
|
|
782
|
+
export interface FbaInboundApiCancelInboundPlanRequest {
|
|
783
|
+
/**
|
|
784
|
+
* Identifier to an inbound plan.
|
|
785
|
+
* @type {string}
|
|
786
|
+
* @memberof FbaInboundApiCancelInboundPlan
|
|
787
|
+
*/
|
|
788
|
+
readonly inboundPlanId: string;
|
|
789
|
+
}
|
|
790
|
+
/**
|
|
791
|
+
* Request parameters for cancelSelfShipAppointment operation in FbaInboundApi.
|
|
792
|
+
* @export
|
|
793
|
+
* @interface FbaInboundApiCancelSelfShipAppointmentRequest
|
|
794
|
+
*/
|
|
795
|
+
export interface FbaInboundApiCancelSelfShipAppointmentRequest {
|
|
796
|
+
/**
|
|
797
|
+
* Identifier to an inbound plan.
|
|
798
|
+
* @type {string}
|
|
799
|
+
* @memberof FbaInboundApiCancelSelfShipAppointment
|
|
800
|
+
*/
|
|
801
|
+
readonly inboundPlanId: string;
|
|
802
|
+
/**
|
|
803
|
+
* Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
804
|
+
* @type {string}
|
|
805
|
+
* @memberof FbaInboundApiCancelSelfShipAppointment
|
|
806
|
+
*/
|
|
807
|
+
readonly shipmentId: string;
|
|
808
|
+
/**
|
|
809
|
+
* Identifier to a self-ship appointment slot.
|
|
810
|
+
* @type {string}
|
|
811
|
+
* @memberof FbaInboundApiCancelSelfShipAppointment
|
|
812
|
+
*/
|
|
813
|
+
readonly slotId: string;
|
|
814
|
+
/**
|
|
815
|
+
* The body of the request to `cancelSelfShipAppointment`.
|
|
816
|
+
* @type {CancelSelfShipAppointmentRequest}
|
|
817
|
+
* @memberof FbaInboundApiCancelSelfShipAppointment
|
|
818
|
+
*/
|
|
819
|
+
readonly body: CancelSelfShipAppointmentRequest;
|
|
820
|
+
}
|
|
821
|
+
/**
|
|
822
|
+
* Request parameters for confirmPackingOption operation in FbaInboundApi.
|
|
823
|
+
* @export
|
|
824
|
+
* @interface FbaInboundApiConfirmPackingOptionRequest
|
|
825
|
+
*/
|
|
826
|
+
export interface FbaInboundApiConfirmPackingOptionRequest {
|
|
827
|
+
/**
|
|
828
|
+
* Identifier to an inbound plan.
|
|
829
|
+
* @type {string}
|
|
830
|
+
* @memberof FbaInboundApiConfirmPackingOption
|
|
831
|
+
*/
|
|
832
|
+
readonly inboundPlanId: string;
|
|
833
|
+
/**
|
|
834
|
+
* Identifier to a packing option.
|
|
835
|
+
* @type {string}
|
|
836
|
+
* @memberof FbaInboundApiConfirmPackingOption
|
|
837
|
+
*/
|
|
838
|
+
readonly packingOptionId: string;
|
|
839
|
+
}
|
|
840
|
+
/**
|
|
841
|
+
* Request parameters for confirmPlacementOption operation in FbaInboundApi.
|
|
842
|
+
* @export
|
|
843
|
+
* @interface FbaInboundApiConfirmPlacementOptionRequest
|
|
844
|
+
*/
|
|
845
|
+
export interface FbaInboundApiConfirmPlacementOptionRequest {
|
|
846
|
+
/**
|
|
847
|
+
* Identifier to an inbound plan.
|
|
848
|
+
* @type {string}
|
|
849
|
+
* @memberof FbaInboundApiConfirmPlacementOption
|
|
850
|
+
*/
|
|
851
|
+
readonly inboundPlanId: string;
|
|
852
|
+
/**
|
|
853
|
+
* Identifier to a placement option. A placement option represents the shipment splits and destinations of SKUs.
|
|
854
|
+
* @type {string}
|
|
855
|
+
* @memberof FbaInboundApiConfirmPlacementOption
|
|
856
|
+
*/
|
|
857
|
+
readonly placementOptionId: string;
|
|
858
|
+
}
|
|
859
|
+
/**
|
|
860
|
+
* Request parameters for confirmTransportationOptions operation in FbaInboundApi.
|
|
861
|
+
* @export
|
|
862
|
+
* @interface FbaInboundApiConfirmTransportationOptionsRequest
|
|
863
|
+
*/
|
|
864
|
+
export interface FbaInboundApiConfirmTransportationOptionsRequest {
|
|
865
|
+
/**
|
|
866
|
+
* Identifier to an inbound plan.
|
|
867
|
+
* @type {string}
|
|
868
|
+
* @memberof FbaInboundApiConfirmTransportationOptions
|
|
869
|
+
*/
|
|
870
|
+
readonly inboundPlanId: string;
|
|
871
|
+
/**
|
|
872
|
+
* The body of the request to `confirmTransportationOptions`.
|
|
873
|
+
* @type {ConfirmTransportationOptionsRequest}
|
|
874
|
+
* @memberof FbaInboundApiConfirmTransportationOptions
|
|
875
|
+
*/
|
|
876
|
+
readonly body: ConfirmTransportationOptionsRequest;
|
|
877
|
+
}
|
|
878
|
+
/**
|
|
879
|
+
* Request parameters for createInboundPlan operation in FbaInboundApi.
|
|
880
|
+
* @export
|
|
881
|
+
* @interface FbaInboundApiCreateInboundPlanRequest
|
|
882
|
+
*/
|
|
883
|
+
export interface FbaInboundApiCreateInboundPlanRequest {
|
|
884
|
+
/**
|
|
885
|
+
* The body of the request to `createInboundPlan`.
|
|
886
|
+
* @type {CreateInboundPlanRequest}
|
|
887
|
+
* @memberof FbaInboundApiCreateInboundPlan
|
|
888
|
+
*/
|
|
889
|
+
readonly body: CreateInboundPlanRequest;
|
|
890
|
+
}
|
|
891
|
+
/**
|
|
892
|
+
* Request parameters for generatePackingOptions operation in FbaInboundApi.
|
|
893
|
+
* @export
|
|
894
|
+
* @interface FbaInboundApiGeneratePackingOptionsRequest
|
|
895
|
+
*/
|
|
896
|
+
export interface FbaInboundApiGeneratePackingOptionsRequest {
|
|
897
|
+
/**
|
|
898
|
+
* Identifier to an inbound plan.
|
|
899
|
+
* @type {string}
|
|
900
|
+
* @memberof FbaInboundApiGeneratePackingOptions
|
|
901
|
+
*/
|
|
902
|
+
readonly inboundPlanId: string;
|
|
903
|
+
}
|
|
904
|
+
/**
|
|
905
|
+
* Request parameters for generatePlacementOptions operation in FbaInboundApi.
|
|
906
|
+
* @export
|
|
907
|
+
* @interface FbaInboundApiGeneratePlacementOptionsRequest
|
|
908
|
+
*/
|
|
909
|
+
export interface FbaInboundApiGeneratePlacementOptionsRequest {
|
|
910
|
+
/**
|
|
911
|
+
* Identifier to an inbound plan.
|
|
912
|
+
* @type {string}
|
|
913
|
+
* @memberof FbaInboundApiGeneratePlacementOptions
|
|
914
|
+
*/
|
|
915
|
+
readonly inboundPlanId: string;
|
|
916
|
+
/**
|
|
917
|
+
* The body of the request to `generatePlacementOptions`.
|
|
918
|
+
* @type {GeneratePlacementOptionsRequest}
|
|
919
|
+
* @memberof FbaInboundApiGeneratePlacementOptions
|
|
920
|
+
*/
|
|
921
|
+
readonly body: GeneratePlacementOptionsRequest;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* Request parameters for generateSelfShipAppointmentSlots operation in FbaInboundApi.
|
|
925
|
+
* @export
|
|
926
|
+
* @interface FbaInboundApiGenerateSelfShipAppointmentSlotsRequest
|
|
927
|
+
*/
|
|
928
|
+
export interface FbaInboundApiGenerateSelfShipAppointmentSlotsRequest {
|
|
929
|
+
/**
|
|
930
|
+
* Identifier to an inbound plan.
|
|
931
|
+
* @type {string}
|
|
932
|
+
* @memberof FbaInboundApiGenerateSelfShipAppointmentSlots
|
|
933
|
+
*/
|
|
934
|
+
readonly inboundPlanId: string;
|
|
935
|
+
/**
|
|
936
|
+
* Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
937
|
+
* @type {string}
|
|
938
|
+
* @memberof FbaInboundApiGenerateSelfShipAppointmentSlots
|
|
939
|
+
*/
|
|
940
|
+
readonly shipmentId: string;
|
|
941
|
+
/**
|
|
942
|
+
* The body of the request `generateSelfShipAppointmentSlots`.
|
|
943
|
+
* @type {GenerateSelfShipAppointmentSlotsRequest}
|
|
944
|
+
* @memberof FbaInboundApiGenerateSelfShipAppointmentSlots
|
|
945
|
+
*/
|
|
946
|
+
readonly body: GenerateSelfShipAppointmentSlotsRequest;
|
|
947
|
+
}
|
|
948
|
+
/**
|
|
949
|
+
* Request parameters for generateTransportationOptions operation in FbaInboundApi.
|
|
950
|
+
* @export
|
|
951
|
+
* @interface FbaInboundApiGenerateTransportationOptionsRequest
|
|
952
|
+
*/
|
|
953
|
+
export interface FbaInboundApiGenerateTransportationOptionsRequest {
|
|
954
|
+
/**
|
|
955
|
+
* Identifier to an inbound plan.
|
|
956
|
+
* @type {string}
|
|
957
|
+
* @memberof FbaInboundApiGenerateTransportationOptions
|
|
958
|
+
*/
|
|
959
|
+
readonly inboundPlanId: string;
|
|
960
|
+
/**
|
|
961
|
+
* The body of the request to `generateTransportationOptions`.
|
|
962
|
+
* @type {GenerateTransportationOptionsRequest}
|
|
963
|
+
* @memberof FbaInboundApiGenerateTransportationOptions
|
|
964
|
+
*/
|
|
965
|
+
readonly body: GenerateTransportationOptionsRequest;
|
|
966
|
+
}
|
|
967
|
+
/**
|
|
968
|
+
* Request parameters for getDeliveryChallanDocument operation in FbaInboundApi.
|
|
969
|
+
* @export
|
|
970
|
+
* @interface FbaInboundApiGetDeliveryChallanDocumentRequest
|
|
971
|
+
*/
|
|
972
|
+
export interface FbaInboundApiGetDeliveryChallanDocumentRequest {
|
|
973
|
+
/**
|
|
974
|
+
* Identifier to an inbound plan.
|
|
975
|
+
* @type {string}
|
|
976
|
+
* @memberof FbaInboundApiGetDeliveryChallanDocument
|
|
977
|
+
*/
|
|
978
|
+
readonly inboundPlanId: string;
|
|
979
|
+
/**
|
|
980
|
+
* Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
981
|
+
* @type {string}
|
|
982
|
+
* @memberof FbaInboundApiGetDeliveryChallanDocument
|
|
983
|
+
*/
|
|
984
|
+
readonly shipmentId: string;
|
|
985
|
+
}
|
|
986
|
+
/**
|
|
987
|
+
* Request parameters for getInboundOperationStatus operation in FbaInboundApi.
|
|
988
|
+
* @export
|
|
989
|
+
* @interface FbaInboundApiGetInboundOperationStatusRequest
|
|
990
|
+
*/
|
|
991
|
+
export interface FbaInboundApiGetInboundOperationStatusRequest {
|
|
992
|
+
/**
|
|
993
|
+
* Identifier to an asynchronous operation.
|
|
994
|
+
* @type {string}
|
|
995
|
+
* @memberof FbaInboundApiGetInboundOperationStatus
|
|
996
|
+
*/
|
|
997
|
+
readonly operationId: string;
|
|
998
|
+
}
|
|
999
|
+
/**
|
|
1000
|
+
* Request parameters for getInboundPlan operation in FbaInboundApi.
|
|
1001
|
+
* @export
|
|
1002
|
+
* @interface FbaInboundApiGetInboundPlanRequest
|
|
1003
|
+
*/
|
|
1004
|
+
export interface FbaInboundApiGetInboundPlanRequest {
|
|
1005
|
+
/**
|
|
1006
|
+
* Identifier to an inbound plan.
|
|
1007
|
+
* @type {string}
|
|
1008
|
+
* @memberof FbaInboundApiGetInboundPlan
|
|
1009
|
+
*/
|
|
1010
|
+
readonly inboundPlanId: string;
|
|
1011
|
+
}
|
|
1012
|
+
/**
|
|
1013
|
+
* Request parameters for getSelfShipAppointmentSlots operation in FbaInboundApi.
|
|
1014
|
+
* @export
|
|
1015
|
+
* @interface FbaInboundApiGetSelfShipAppointmentSlotsRequest
|
|
1016
|
+
*/
|
|
1017
|
+
export interface FbaInboundApiGetSelfShipAppointmentSlotsRequest {
|
|
1018
|
+
/**
|
|
1019
|
+
* Identifier to an inbound plan.
|
|
1020
|
+
* @type {string}
|
|
1021
|
+
* @memberof FbaInboundApiGetSelfShipAppointmentSlots
|
|
1022
|
+
*/
|
|
1023
|
+
readonly inboundPlanId: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
1026
|
+
* @type {string}
|
|
1027
|
+
* @memberof FbaInboundApiGetSelfShipAppointmentSlots
|
|
1028
|
+
*/
|
|
1029
|
+
readonly shipmentId: string;
|
|
1030
|
+
/**
|
|
1031
|
+
* The number of self ship appointment slots to return in the response matching the given query.
|
|
1032
|
+
* @type {number}
|
|
1033
|
+
* @memberof FbaInboundApiGetSelfShipAppointmentSlots
|
|
1034
|
+
*/
|
|
1035
|
+
readonly pageSize?: number;
|
|
1036
|
+
/**
|
|
1037
|
+
* A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1038
|
+
* @type {string}
|
|
1039
|
+
* @memberof FbaInboundApiGetSelfShipAppointmentSlots
|
|
1040
|
+
*/
|
|
1041
|
+
readonly paginationToken?: string;
|
|
1042
|
+
}
|
|
1043
|
+
/**
|
|
1044
|
+
* Request parameters for getShipment operation in FbaInboundApi.
|
|
1045
|
+
* @export
|
|
1046
|
+
* @interface FbaInboundApiGetShipmentRequest
|
|
1047
|
+
*/
|
|
1048
|
+
export interface FbaInboundApiGetShipmentRequest {
|
|
1049
|
+
/**
|
|
1050
|
+
* Identifier to an inbound plan.
|
|
1051
|
+
* @type {string}
|
|
1052
|
+
* @memberof FbaInboundApiGetShipment
|
|
1053
|
+
*/
|
|
1054
|
+
readonly inboundPlanId: string;
|
|
1055
|
+
/**
|
|
1056
|
+
* Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
1057
|
+
* @type {string}
|
|
1058
|
+
* @memberof FbaInboundApiGetShipment
|
|
1059
|
+
*/
|
|
1060
|
+
readonly shipmentId: string;
|
|
1061
|
+
}
|
|
1062
|
+
/**
|
|
1063
|
+
* Request parameters for listInboundPlanBoxes operation in FbaInboundApi.
|
|
1064
|
+
* @export
|
|
1065
|
+
* @interface FbaInboundApiListInboundPlanBoxesRequest
|
|
1066
|
+
*/
|
|
1067
|
+
export interface FbaInboundApiListInboundPlanBoxesRequest {
|
|
1068
|
+
/**
|
|
1069
|
+
* Identifier to an inbound plan.
|
|
1070
|
+
* @type {string}
|
|
1071
|
+
* @memberof FbaInboundApiListInboundPlanBoxes
|
|
1072
|
+
*/
|
|
1073
|
+
readonly inboundPlanId: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* The number of boxes to return in the response matching the given query.
|
|
1076
|
+
* @type {number}
|
|
1077
|
+
* @memberof FbaInboundApiListInboundPlanBoxes
|
|
1078
|
+
*/
|
|
1079
|
+
readonly pageSize?: number;
|
|
1080
|
+
/**
|
|
1081
|
+
* A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1082
|
+
* @type {string}
|
|
1083
|
+
* @memberof FbaInboundApiListInboundPlanBoxes
|
|
1084
|
+
*/
|
|
1085
|
+
readonly paginationToken?: string;
|
|
1086
|
+
}
|
|
1087
|
+
/**
|
|
1088
|
+
* Request parameters for listInboundPlanItems operation in FbaInboundApi.
|
|
1089
|
+
* @export
|
|
1090
|
+
* @interface FbaInboundApiListInboundPlanItemsRequest
|
|
1091
|
+
*/
|
|
1092
|
+
export interface FbaInboundApiListInboundPlanItemsRequest {
|
|
1093
|
+
/**
|
|
1094
|
+
* Identifier to an inbound plan.
|
|
1095
|
+
* @type {string}
|
|
1096
|
+
* @memberof FbaInboundApiListInboundPlanItems
|
|
1097
|
+
*/
|
|
1098
|
+
readonly inboundPlanId: string;
|
|
1099
|
+
/**
|
|
1100
|
+
* The number of items to return in the response matching the given query.
|
|
1101
|
+
* @type {number}
|
|
1102
|
+
* @memberof FbaInboundApiListInboundPlanItems
|
|
1103
|
+
*/
|
|
1104
|
+
readonly pageSize?: number;
|
|
1105
|
+
/**
|
|
1106
|
+
* A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1107
|
+
* @type {string}
|
|
1108
|
+
* @memberof FbaInboundApiListInboundPlanItems
|
|
1109
|
+
*/
|
|
1110
|
+
readonly paginationToken?: string;
|
|
1111
|
+
}
|
|
1112
|
+
/**
|
|
1113
|
+
* Request parameters for listInboundPlanPallets operation in FbaInboundApi.
|
|
1114
|
+
* @export
|
|
1115
|
+
* @interface FbaInboundApiListInboundPlanPalletsRequest
|
|
1116
|
+
*/
|
|
1117
|
+
export interface FbaInboundApiListInboundPlanPalletsRequest {
|
|
1118
|
+
/**
|
|
1119
|
+
* Identifier to an inbound plan.
|
|
1120
|
+
* @type {string}
|
|
1121
|
+
* @memberof FbaInboundApiListInboundPlanPallets
|
|
1122
|
+
*/
|
|
1123
|
+
readonly inboundPlanId: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* The number of pallets to return in the response matching the given query.
|
|
1126
|
+
* @type {number}
|
|
1127
|
+
* @memberof FbaInboundApiListInboundPlanPallets
|
|
1128
|
+
*/
|
|
1129
|
+
readonly pageSize?: number;
|
|
1130
|
+
/**
|
|
1131
|
+
* A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1132
|
+
* @type {string}
|
|
1133
|
+
* @memberof FbaInboundApiListInboundPlanPallets
|
|
1134
|
+
*/
|
|
1135
|
+
readonly paginationToken?: string;
|
|
1136
|
+
}
|
|
1137
|
+
/**
|
|
1138
|
+
* Request parameters for listInboundPlans operation in FbaInboundApi.
|
|
1139
|
+
* @export
|
|
1140
|
+
* @interface FbaInboundApiListInboundPlansRequest
|
|
1141
|
+
*/
|
|
1142
|
+
export interface FbaInboundApiListInboundPlansRequest {
|
|
1143
|
+
/**
|
|
1144
|
+
* The number of inbound plans to return in the response matching the given query.
|
|
1145
|
+
* @type {number}
|
|
1146
|
+
* @memberof FbaInboundApiListInboundPlans
|
|
1147
|
+
*/
|
|
1148
|
+
readonly pageSize?: number;
|
|
1149
|
+
/**
|
|
1150
|
+
* A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1151
|
+
* @type {string}
|
|
1152
|
+
* @memberof FbaInboundApiListInboundPlans
|
|
1153
|
+
*/
|
|
1154
|
+
readonly paginationToken?: string;
|
|
1155
|
+
/**
|
|
1156
|
+
* The status of an inbound plan.
|
|
1157
|
+
* @type {'ACTIVE' | 'VOIDED' | 'SHIPPED'}
|
|
1158
|
+
* @memberof FbaInboundApiListInboundPlans
|
|
1159
|
+
*/
|
|
1160
|
+
readonly status?: 'ACTIVE' | 'VOIDED' | 'SHIPPED';
|
|
1161
|
+
/**
|
|
1162
|
+
* Sort by field.
|
|
1163
|
+
* @type {'LAST_UPDATED_TIME' | 'CREATION_TIME'}
|
|
1164
|
+
* @memberof FbaInboundApiListInboundPlans
|
|
1165
|
+
*/
|
|
1166
|
+
readonly sortBy?: 'LAST_UPDATED_TIME' | 'CREATION_TIME';
|
|
1167
|
+
/**
|
|
1168
|
+
* The sort order.
|
|
1169
|
+
* @type {'ASC' | 'DESC'}
|
|
1170
|
+
* @memberof FbaInboundApiListInboundPlans
|
|
1171
|
+
*/
|
|
1172
|
+
readonly sortOrder?: 'ASC' | 'DESC';
|
|
1173
|
+
}
|
|
1174
|
+
/**
|
|
1175
|
+
* Request parameters for listItemComplianceDetails operation in FbaInboundApi.
|
|
1176
|
+
* @export
|
|
1177
|
+
* @interface FbaInboundApiListItemComplianceDetailsRequest
|
|
1178
|
+
*/
|
|
1179
|
+
export interface FbaInboundApiListItemComplianceDetailsRequest {
|
|
1180
|
+
/**
|
|
1181
|
+
* List of merchant SKUs, a merchant-supplied identifier for a specific SKU.
|
|
1182
|
+
* @type {Array<string>}
|
|
1183
|
+
* @memberof FbaInboundApiListItemComplianceDetails
|
|
1184
|
+
*/
|
|
1185
|
+
readonly mskus: Array<string>;
|
|
1186
|
+
/**
|
|
1187
|
+
* The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
|
|
1188
|
+
* @type {string}
|
|
1189
|
+
* @memberof FbaInboundApiListItemComplianceDetails
|
|
1190
|
+
*/
|
|
1191
|
+
readonly marketplaceId: string;
|
|
1192
|
+
}
|
|
1193
|
+
/**
|
|
1194
|
+
* Request parameters for listPackingGroupItems operation in FbaInboundApi.
|
|
1195
|
+
* @export
|
|
1196
|
+
* @interface FbaInboundApiListPackingGroupItemsRequest
|
|
1197
|
+
*/
|
|
1198
|
+
export interface FbaInboundApiListPackingGroupItemsRequest {
|
|
1199
|
+
/**
|
|
1200
|
+
* Identifier to an inbound plan.
|
|
1201
|
+
* @type {string}
|
|
1202
|
+
* @memberof FbaInboundApiListPackingGroupItems
|
|
1203
|
+
*/
|
|
1204
|
+
readonly inboundPlanId: string;
|
|
1205
|
+
/**
|
|
1206
|
+
* Identifier to a packing option.
|
|
1207
|
+
* @type {string}
|
|
1208
|
+
* @memberof FbaInboundApiListPackingGroupItems
|
|
1209
|
+
*/
|
|
1210
|
+
readonly packingOptionId: string;
|
|
1211
|
+
/**
|
|
1212
|
+
* Identifier to a packing group.
|
|
1213
|
+
* @type {string}
|
|
1214
|
+
* @memberof FbaInboundApiListPackingGroupItems
|
|
1215
|
+
*/
|
|
1216
|
+
readonly packingGroupId: string;
|
|
1217
|
+
/**
|
|
1218
|
+
* The number of packing group items to return in the response matching the given query.
|
|
1219
|
+
* @type {number}
|
|
1220
|
+
* @memberof FbaInboundApiListPackingGroupItems
|
|
1221
|
+
*/
|
|
1222
|
+
readonly pageSize?: number;
|
|
1223
|
+
/**
|
|
1224
|
+
* A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1225
|
+
* @type {string}
|
|
1226
|
+
* @memberof FbaInboundApiListPackingGroupItems
|
|
1227
|
+
*/
|
|
1228
|
+
readonly paginationToken?: string;
|
|
1229
|
+
}
|
|
1230
|
+
/**
|
|
1231
|
+
* Request parameters for listPackingOptions operation in FbaInboundApi.
|
|
1232
|
+
* @export
|
|
1233
|
+
* @interface FbaInboundApiListPackingOptionsRequest
|
|
1234
|
+
*/
|
|
1235
|
+
export interface FbaInboundApiListPackingOptionsRequest {
|
|
1236
|
+
/**
|
|
1237
|
+
* Identifier to an inbound plan.
|
|
1238
|
+
* @type {string}
|
|
1239
|
+
* @memberof FbaInboundApiListPackingOptions
|
|
1240
|
+
*/
|
|
1241
|
+
readonly inboundPlanId: string;
|
|
1242
|
+
/**
|
|
1243
|
+
* The number of packing options to return in the response matching the given query.
|
|
1244
|
+
* @type {number}
|
|
1245
|
+
* @memberof FbaInboundApiListPackingOptions
|
|
1246
|
+
*/
|
|
1247
|
+
readonly pageSize?: number;
|
|
1248
|
+
/**
|
|
1249
|
+
* A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1250
|
+
* @type {string}
|
|
1251
|
+
* @memberof FbaInboundApiListPackingOptions
|
|
1252
|
+
*/
|
|
1253
|
+
readonly paginationToken?: string;
|
|
1254
|
+
}
|
|
1255
|
+
/**
|
|
1256
|
+
* Request parameters for listPlacementOptions operation in FbaInboundApi.
|
|
1257
|
+
* @export
|
|
1258
|
+
* @interface FbaInboundApiListPlacementOptionsRequest
|
|
1259
|
+
*/
|
|
1260
|
+
export interface FbaInboundApiListPlacementOptionsRequest {
|
|
1261
|
+
/**
|
|
1262
|
+
* Identifier to an inbound plan.
|
|
1263
|
+
* @type {string}
|
|
1264
|
+
* @memberof FbaInboundApiListPlacementOptions
|
|
1265
|
+
*/
|
|
1266
|
+
readonly inboundPlanId: string;
|
|
1267
|
+
/**
|
|
1268
|
+
* The number of placement options to return in the response matching the given query.
|
|
1269
|
+
* @type {number}
|
|
1270
|
+
* @memberof FbaInboundApiListPlacementOptions
|
|
1271
|
+
*/
|
|
1272
|
+
readonly pageSize?: number;
|
|
1273
|
+
/**
|
|
1274
|
+
* A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1275
|
+
* @type {string}
|
|
1276
|
+
* @memberof FbaInboundApiListPlacementOptions
|
|
1277
|
+
*/
|
|
1278
|
+
readonly paginationToken?: string;
|
|
1279
|
+
}
|
|
1280
|
+
/**
|
|
1281
|
+
* Request parameters for listTransportationOptions operation in FbaInboundApi.
|
|
1282
|
+
* @export
|
|
1283
|
+
* @interface FbaInboundApiListTransportationOptionsRequest
|
|
1284
|
+
*/
|
|
1285
|
+
export interface FbaInboundApiListTransportationOptionsRequest {
|
|
1286
|
+
/**
|
|
1287
|
+
* Identifier to an inbound plan.
|
|
1288
|
+
* @type {string}
|
|
1289
|
+
* @memberof FbaInboundApiListTransportationOptions
|
|
1290
|
+
*/
|
|
1291
|
+
readonly inboundPlanId: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* The number of transportation options to return in the response matching the given query.
|
|
1294
|
+
* @type {number}
|
|
1295
|
+
* @memberof FbaInboundApiListTransportationOptions
|
|
1296
|
+
*/
|
|
1297
|
+
readonly pageSize?: number;
|
|
1298
|
+
/**
|
|
1299
|
+
* A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1300
|
+
* @type {string}
|
|
1301
|
+
* @memberof FbaInboundApiListTransportationOptions
|
|
1302
|
+
*/
|
|
1303
|
+
readonly paginationToken?: string;
|
|
1304
|
+
/**
|
|
1305
|
+
* The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
|
|
1306
|
+
* @type {string}
|
|
1307
|
+
* @memberof FbaInboundApiListTransportationOptions
|
|
1308
|
+
*/
|
|
1309
|
+
readonly placementOptionId?: string;
|
|
1310
|
+
/**
|
|
1311
|
+
* The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
|
|
1312
|
+
* @type {string}
|
|
1313
|
+
* @memberof FbaInboundApiListTransportationOptions
|
|
1314
|
+
*/
|
|
1315
|
+
readonly shipmentId?: string;
|
|
1316
|
+
}
|
|
1317
|
+
/**
|
|
1318
|
+
* Request parameters for scheduleSelfShipAppointment operation in FbaInboundApi.
|
|
1319
|
+
* @export
|
|
1320
|
+
* @interface FbaInboundApiScheduleSelfShipAppointmentRequest
|
|
1321
|
+
*/
|
|
1322
|
+
export interface FbaInboundApiScheduleSelfShipAppointmentRequest {
|
|
1323
|
+
/**
|
|
1324
|
+
* Identifier to an inbound plan.
|
|
1325
|
+
* @type {string}
|
|
1326
|
+
* @memberof FbaInboundApiScheduleSelfShipAppointment
|
|
1327
|
+
*/
|
|
1328
|
+
readonly inboundPlanId: string;
|
|
1329
|
+
/**
|
|
1330
|
+
* Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
1331
|
+
* @type {string}
|
|
1332
|
+
* @memberof FbaInboundApiScheduleSelfShipAppointment
|
|
1333
|
+
*/
|
|
1334
|
+
readonly shipmentId: string;
|
|
1335
|
+
/**
|
|
1336
|
+
* Identifier to a self-ship appointment slot.
|
|
1337
|
+
* @type {string}
|
|
1338
|
+
* @memberof FbaInboundApiScheduleSelfShipAppointment
|
|
1339
|
+
*/
|
|
1340
|
+
readonly slotId: string;
|
|
1341
|
+
/**
|
|
1342
|
+
* The body of the request to `scheduleSelfShipAppointment`.
|
|
1343
|
+
* @type {ScheduleSelfShipAppointmentRequest}
|
|
1344
|
+
* @memberof FbaInboundApiScheduleSelfShipAppointment
|
|
1345
|
+
*/
|
|
1346
|
+
readonly body: ScheduleSelfShipAppointmentRequest;
|
|
1347
|
+
}
|
|
1348
|
+
/**
|
|
1349
|
+
* Request parameters for setPackingInformation operation in FbaInboundApi.
|
|
1350
|
+
* @export
|
|
1351
|
+
* @interface FbaInboundApiSetPackingInformationRequest
|
|
1352
|
+
*/
|
|
1353
|
+
export interface FbaInboundApiSetPackingInformationRequest {
|
|
1354
|
+
/**
|
|
1355
|
+
* Identifier to an inbound plan.
|
|
1356
|
+
* @type {string}
|
|
1357
|
+
* @memberof FbaInboundApiSetPackingInformation
|
|
1358
|
+
*/
|
|
1359
|
+
readonly inboundPlanId: string;
|
|
1360
|
+
/**
|
|
1361
|
+
* The body of the request to `setPackingInformation`.
|
|
1362
|
+
* @type {SetPackingInformationRequest}
|
|
1363
|
+
* @memberof FbaInboundApiSetPackingInformation
|
|
1364
|
+
*/
|
|
1365
|
+
readonly body: SetPackingInformationRequest;
|
|
1366
|
+
}
|
|
1367
|
+
/**
|
|
1368
|
+
* Request parameters for updateItemComplianceDetails operation in FbaInboundApi.
|
|
1369
|
+
* @export
|
|
1370
|
+
* @interface FbaInboundApiUpdateItemComplianceDetailsRequest
|
|
1371
|
+
*/
|
|
1372
|
+
export interface FbaInboundApiUpdateItemComplianceDetailsRequest {
|
|
1373
|
+
/**
|
|
1374
|
+
* The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
|
|
1375
|
+
* @type {string}
|
|
1376
|
+
* @memberof FbaInboundApiUpdateItemComplianceDetails
|
|
1377
|
+
*/
|
|
1378
|
+
readonly marketplaceId: string;
|
|
1379
|
+
/**
|
|
1380
|
+
* The body of the request to `updateItemComplianceDetails`.
|
|
1381
|
+
* @type {UpdateItemComplianceDetailsRequest}
|
|
1382
|
+
* @memberof FbaInboundApiUpdateItemComplianceDetails
|
|
1383
|
+
*/
|
|
1384
|
+
readonly body: UpdateItemComplianceDetailsRequest;
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
* Request parameters for updateShipmentDeliveryWindow operation in FbaInboundApi.
|
|
1388
|
+
* @export
|
|
1389
|
+
* @interface FbaInboundApiUpdateShipmentDeliveryWindowRequest
|
|
1390
|
+
*/
|
|
1391
|
+
export interface FbaInboundApiUpdateShipmentDeliveryWindowRequest {
|
|
1392
|
+
/**
|
|
1393
|
+
* Identifier to an inbound plan.
|
|
1394
|
+
* @type {string}
|
|
1395
|
+
* @memberof FbaInboundApiUpdateShipmentDeliveryWindow
|
|
1396
|
+
*/
|
|
1397
|
+
readonly inboundPlanId: string;
|
|
1398
|
+
/**
|
|
1399
|
+
* Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
1400
|
+
* @type {string}
|
|
1401
|
+
* @memberof FbaInboundApiUpdateShipmentDeliveryWindow
|
|
1402
|
+
*/
|
|
1403
|
+
readonly shipmentId: string;
|
|
1404
|
+
/**
|
|
1405
|
+
* The body of the request to `updateShipmentDeliveryWindow`.
|
|
1406
|
+
* @type {UpdateShipmentDeliveryWindowRequest}
|
|
1407
|
+
* @memberof FbaInboundApiUpdateShipmentDeliveryWindow
|
|
1408
|
+
*/
|
|
1409
|
+
readonly body: UpdateShipmentDeliveryWindowRequest;
|
|
1410
|
+
}
|
|
1411
|
+
/**
|
|
1412
|
+
* Request parameters for updateShipmentTrackingDetails operation in FbaInboundApi.
|
|
1413
|
+
* @export
|
|
1414
|
+
* @interface FbaInboundApiUpdateShipmentTrackingDetailsRequest
|
|
1415
|
+
*/
|
|
1416
|
+
export interface FbaInboundApiUpdateShipmentTrackingDetailsRequest {
|
|
1417
|
+
/**
|
|
1418
|
+
* Identifier to an inbound plan.
|
|
1419
|
+
* @type {string}
|
|
1420
|
+
* @memberof FbaInboundApiUpdateShipmentTrackingDetails
|
|
1421
|
+
*/
|
|
1422
|
+
readonly inboundPlanId: string;
|
|
1423
|
+
/**
|
|
1424
|
+
* Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
1425
|
+
* @type {string}
|
|
1426
|
+
* @memberof FbaInboundApiUpdateShipmentTrackingDetails
|
|
1427
|
+
*/
|
|
1428
|
+
readonly shipmentId: string;
|
|
1429
|
+
/**
|
|
1430
|
+
* The body of the request to `updateShipmentTrackingDetails`.
|
|
1431
|
+
* @type {UpdateShipmentTrackingDetailsRequest}
|
|
1432
|
+
* @memberof FbaInboundApiUpdateShipmentTrackingDetails
|
|
1433
|
+
*/
|
|
1434
|
+
readonly body: UpdateShipmentTrackingDetailsRequest;
|
|
1435
|
+
}
|
|
1436
|
+
/**
|
|
1437
|
+
* FbaInboundApi - object-oriented interface
|
|
1438
|
+
* @export
|
|
1439
|
+
* @class FbaInboundApi
|
|
1440
|
+
* @extends {BaseAPI}
|
|
1441
|
+
*/
|
|
1442
|
+
export declare class FbaInboundApi extends BaseAPI {
|
|
1443
|
+
/**
|
|
1444
|
+
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1445
|
+
* @param {FbaInboundApiCancelInboundPlanRequest} requestParameters Request parameters.
|
|
1446
|
+
* @param {*} [options] Override http request option.
|
|
1447
|
+
* @throws {RequiredError}
|
|
1448
|
+
* @memberof FbaInboundApi
|
|
1449
|
+
*/
|
|
1450
|
+
cancelInboundPlan(requestParameters: FbaInboundApiCancelInboundPlanRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<CancelInboundPlanResponse, any>>;
|
|
1451
|
+
/**
|
|
1452
|
+
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1453
|
+
* @param {FbaInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
1454
|
+
* @param {*} [options] Override http request option.
|
|
1455
|
+
* @throws {RequiredError}
|
|
1456
|
+
* @memberof FbaInboundApi
|
|
1457
|
+
*/
|
|
1458
|
+
cancelSelfShipAppointment(requestParameters: FbaInboundApiCancelSelfShipAppointmentRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<CancelSelfShipAppointmentResponse, any>>;
|
|
1459
|
+
/**
|
|
1460
|
+
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1461
|
+
* @param {FbaInboundApiConfirmPackingOptionRequest} requestParameters Request parameters.
|
|
1462
|
+
* @param {*} [options] Override http request option.
|
|
1463
|
+
* @throws {RequiredError}
|
|
1464
|
+
* @memberof FbaInboundApi
|
|
1465
|
+
*/
|
|
1466
|
+
confirmPackingOption(requestParameters: FbaInboundApiConfirmPackingOptionRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ConfirmPackingOptionResponse, any>>;
|
|
1467
|
+
/**
|
|
1468
|
+
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1469
|
+
* @param {FbaInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters.
|
|
1470
|
+
* @param {*} [options] Override http request option.
|
|
1471
|
+
* @throws {RequiredError}
|
|
1472
|
+
* @memberof FbaInboundApi
|
|
1473
|
+
*/
|
|
1474
|
+
confirmPlacementOption(requestParameters: FbaInboundApiConfirmPlacementOptionRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ConfirmPlacementOptionResponse, any>>;
|
|
1475
|
+
/**
|
|
1476
|
+
* Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1477
|
+
* @param {FbaInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters.
|
|
1478
|
+
* @param {*} [options] Override http request option.
|
|
1479
|
+
* @throws {RequiredError}
|
|
1480
|
+
* @memberof FbaInboundApi
|
|
1481
|
+
*/
|
|
1482
|
+
confirmTransportationOptions(requestParameters: FbaInboundApiConfirmTransportationOptionsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ConfirmTransportationOptionsResponse, any>>;
|
|
1483
|
+
/**
|
|
1484
|
+
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1485
|
+
* @param {FbaInboundApiCreateInboundPlanRequest} requestParameters Request parameters.
|
|
1486
|
+
* @param {*} [options] Override http request option.
|
|
1487
|
+
* @throws {RequiredError}
|
|
1488
|
+
* @memberof FbaInboundApi
|
|
1489
|
+
*/
|
|
1490
|
+
createInboundPlan(requestParameters: FbaInboundApiCreateInboundPlanRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInboundPlanResponse, any>>;
|
|
1491
|
+
/**
|
|
1492
|
+
* Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1493
|
+
* @param {FbaInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters.
|
|
1494
|
+
* @param {*} [options] Override http request option.
|
|
1495
|
+
* @throws {RequiredError}
|
|
1496
|
+
* @memberof FbaInboundApi
|
|
1497
|
+
*/
|
|
1498
|
+
generatePackingOptions(requestParameters: FbaInboundApiGeneratePackingOptionsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GeneratePackingOptionsResponse, any>>;
|
|
1499
|
+
/**
|
|
1500
|
+
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1501
|
+
* @param {FbaInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters.
|
|
1502
|
+
* @param {*} [options] Override http request option.
|
|
1503
|
+
* @throws {RequiredError}
|
|
1504
|
+
* @memberof FbaInboundApi
|
|
1505
|
+
*/
|
|
1506
|
+
generatePlacementOptions(requestParameters: FbaInboundApiGeneratePlacementOptionsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GeneratePlacementOptionsResponse, any>>;
|
|
1507
|
+
/**
|
|
1508
|
+
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1509
|
+
* @param {FbaInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
1510
|
+
* @param {*} [options] Override http request option.
|
|
1511
|
+
* @throws {RequiredError}
|
|
1512
|
+
* @memberof FbaInboundApi
|
|
1513
|
+
*/
|
|
1514
|
+
generateSelfShipAppointmentSlots(requestParameters: FbaInboundApiGenerateSelfShipAppointmentSlotsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GenerateSelfShipAppointmentSlotsResponse, any>>;
|
|
1515
|
+
/**
|
|
1516
|
+
* Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1517
|
+
* @param {FbaInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters.
|
|
1518
|
+
* @param {*} [options] Override http request option.
|
|
1519
|
+
* @throws {RequiredError}
|
|
1520
|
+
* @memberof FbaInboundApi
|
|
1521
|
+
*/
|
|
1522
|
+
generateTransportationOptions(requestParameters: FbaInboundApiGenerateTransportationOptionsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GenerateTransportationOptionsResponse, any>>;
|
|
1523
|
+
/**
|
|
1524
|
+
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1525
|
+
* @param {FbaInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters.
|
|
1526
|
+
* @param {*} [options] Override http request option.
|
|
1527
|
+
* @throws {RequiredError}
|
|
1528
|
+
* @memberof FbaInboundApi
|
|
1529
|
+
*/
|
|
1530
|
+
getDeliveryChallanDocument(requestParameters: FbaInboundApiGetDeliveryChallanDocumentRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDeliveryChallanDocumentResponse, any>>;
|
|
1531
|
+
/**
|
|
1532
|
+
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1533
|
+
* @param {FbaInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters.
|
|
1534
|
+
* @param {*} [options] Override http request option.
|
|
1535
|
+
* @throws {RequiredError}
|
|
1536
|
+
* @memberof FbaInboundApi
|
|
1537
|
+
*/
|
|
1538
|
+
getInboundOperationStatus(requestParameters: FbaInboundApiGetInboundOperationStatusRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<InboundOperationStatus, any>>;
|
|
1539
|
+
/**
|
|
1540
|
+
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1541
|
+
* @param {FbaInboundApiGetInboundPlanRequest} requestParameters Request parameters.
|
|
1542
|
+
* @param {*} [options] Override http request option.
|
|
1543
|
+
* @throws {RequiredError}
|
|
1544
|
+
* @memberof FbaInboundApi
|
|
1545
|
+
*/
|
|
1546
|
+
getInboundPlan(requestParameters: FbaInboundApiGetInboundPlanRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<InboundPlan, any>>;
|
|
1547
|
+
/**
|
|
1548
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1549
|
+
* @param {FbaInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
1550
|
+
* @param {*} [options] Override http request option.
|
|
1551
|
+
* @throws {RequiredError}
|
|
1552
|
+
* @memberof FbaInboundApi
|
|
1553
|
+
*/
|
|
1554
|
+
getSelfShipAppointmentSlots(requestParameters: FbaInboundApiGetSelfShipAppointmentSlotsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetSelfShipAppointmentSlotsResponse, any>>;
|
|
1555
|
+
/**
|
|
1556
|
+
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1557
|
+
* @param {FbaInboundApiGetShipmentRequest} requestParameters Request parameters.
|
|
1558
|
+
* @param {*} [options] Override http request option.
|
|
1559
|
+
* @throws {RequiredError}
|
|
1560
|
+
* @memberof FbaInboundApi
|
|
1561
|
+
*/
|
|
1562
|
+
getShipment(requestParameters: FbaInboundApiGetShipmentRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<Shipment, any>>;
|
|
1563
|
+
/**
|
|
1564
|
+
* Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1565
|
+
* @param {FbaInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters.
|
|
1566
|
+
* @param {*} [options] Override http request option.
|
|
1567
|
+
* @throws {RequiredError}
|
|
1568
|
+
* @memberof FbaInboundApi
|
|
1569
|
+
*/
|
|
1570
|
+
listInboundPlanBoxes(requestParameters: FbaInboundApiListInboundPlanBoxesRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListInboundPlanBoxesResponse, any>>;
|
|
1571
|
+
/**
|
|
1572
|
+
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1573
|
+
* @param {FbaInboundApiListInboundPlanItemsRequest} requestParameters Request parameters.
|
|
1574
|
+
* @param {*} [options] Override http request option.
|
|
1575
|
+
* @throws {RequiredError}
|
|
1576
|
+
* @memberof FbaInboundApi
|
|
1577
|
+
*/
|
|
1578
|
+
listInboundPlanItems(requestParameters: FbaInboundApiListInboundPlanItemsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListInboundPlanItemsResponse, any>>;
|
|
1579
|
+
/**
|
|
1580
|
+
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1581
|
+
* @param {FbaInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters.
|
|
1582
|
+
* @param {*} [options] Override http request option.
|
|
1583
|
+
* @throws {RequiredError}
|
|
1584
|
+
* @memberof FbaInboundApi
|
|
1585
|
+
*/
|
|
1586
|
+
listInboundPlanPallets(requestParameters: FbaInboundApiListInboundPlanPalletsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListInboundPlanPalletsResponse, any>>;
|
|
1587
|
+
/**
|
|
1588
|
+
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1589
|
+
* @param {FbaInboundApiListInboundPlansRequest} requestParameters Request parameters.
|
|
1590
|
+
* @param {*} [options] Override http request option.
|
|
1591
|
+
* @throws {RequiredError}
|
|
1592
|
+
* @memberof FbaInboundApi
|
|
1593
|
+
*/
|
|
1594
|
+
listInboundPlans(requestParameters?: FbaInboundApiListInboundPlansRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListInboundPlansResponse, any>>;
|
|
1595
|
+
/**
|
|
1596
|
+
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1597
|
+
* @param {FbaInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
1598
|
+
* @param {*} [options] Override http request option.
|
|
1599
|
+
* @throws {RequiredError}
|
|
1600
|
+
* @memberof FbaInboundApi
|
|
1601
|
+
*/
|
|
1602
|
+
listItemComplianceDetails(requestParameters: FbaInboundApiListItemComplianceDetailsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListItemComplianceDetailsResponse, any>>;
|
|
1603
|
+
/**
|
|
1604
|
+
* Retrieves a list of all items in a packing options\'s packing group. Packing options must first be generated by the corresponding endpoint before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1605
|
+
* @param {FbaInboundApiListPackingGroupItemsRequest} requestParameters Request parameters.
|
|
1606
|
+
* @param {*} [options] Override http request option.
|
|
1607
|
+
* @throws {RequiredError}
|
|
1608
|
+
* @memberof FbaInboundApi
|
|
1609
|
+
*/
|
|
1610
|
+
listPackingGroupItems(requestParameters: FbaInboundApiListPackingGroupItemsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListPackingGroupItemsResponse, any>>;
|
|
1611
|
+
/**
|
|
1612
|
+
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1613
|
+
* @param {FbaInboundApiListPackingOptionsRequest} requestParameters Request parameters.
|
|
1614
|
+
* @param {*} [options] Override http request option.
|
|
1615
|
+
* @throws {RequiredError}
|
|
1616
|
+
* @memberof FbaInboundApi
|
|
1617
|
+
*/
|
|
1618
|
+
listPackingOptions(requestParameters: FbaInboundApiListPackingOptionsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListPackingOptionsResponse, any>>;
|
|
1619
|
+
/**
|
|
1620
|
+
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1621
|
+
* @param {FbaInboundApiListPlacementOptionsRequest} requestParameters Request parameters.
|
|
1622
|
+
* @param {*} [options] Override http request option.
|
|
1623
|
+
* @throws {RequiredError}
|
|
1624
|
+
* @memberof FbaInboundApi
|
|
1625
|
+
*/
|
|
1626
|
+
listPlacementOptions(requestParameters: FbaInboundApiListPlacementOptionsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListPlacementOptionsResponse, any>>;
|
|
1627
|
+
/**
|
|
1628
|
+
* Retrieves all transportation options for a shipment. Transportation options must first be generated by the corresponding endpoint before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1629
|
+
* @param {FbaInboundApiListTransportationOptionsRequest} requestParameters Request parameters.
|
|
1630
|
+
* @param {*} [options] Override http request option.
|
|
1631
|
+
* @throws {RequiredError}
|
|
1632
|
+
* @memberof FbaInboundApi
|
|
1633
|
+
*/
|
|
1634
|
+
listTransportationOptions(requestParameters: FbaInboundApiListTransportationOptionsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListTransportationOptionsResponse, any>>;
|
|
1635
|
+
/**
|
|
1636
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1637
|
+
* @param {FbaInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
1638
|
+
* @param {*} [options] Override http request option.
|
|
1639
|
+
* @throws {RequiredError}
|
|
1640
|
+
* @memberof FbaInboundApi
|
|
1641
|
+
*/
|
|
1642
|
+
scheduleSelfShipAppointment(requestParameters: FbaInboundApiScheduleSelfShipAppointmentRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<ScheduleSelfShipAppointmentResponse, any>>;
|
|
1643
|
+
/**
|
|
1644
|
+
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.05 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1645
|
+
* @param {FbaInboundApiSetPackingInformationRequest} requestParameters Request parameters.
|
|
1646
|
+
* @param {*} [options] Override http request option.
|
|
1647
|
+
* @throws {RequiredError}
|
|
1648
|
+
* @memberof FbaInboundApi
|
|
1649
|
+
*/
|
|
1650
|
+
setPackingInformation(requestParameters: FbaInboundApiSetPackingInformationRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<SetPackingInformationResponse, any>>;
|
|
1651
|
+
/**
|
|
1652
|
+
* Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1653
|
+
* @param {FbaInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
1654
|
+
* @param {*} [options] Override http request option.
|
|
1655
|
+
* @throws {RequiredError}
|
|
1656
|
+
* @memberof FbaInboundApi
|
|
1657
|
+
*/
|
|
1658
|
+
updateItemComplianceDetails(requestParameters: FbaInboundApiUpdateItemComplianceDetailsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateItemComplianceDetailsResponse, any>>;
|
|
1659
|
+
/**
|
|
1660
|
+
* Update the time window that a shipment will be delivered to the warehouse. The window is used to provide the expected time that a non-Amazon partnered carrier will arrive at the warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1661
|
+
* @param {FbaInboundApiUpdateShipmentDeliveryWindowRequest} requestParameters Request parameters.
|
|
1662
|
+
* @param {*} [options] Override http request option.
|
|
1663
|
+
* @throws {RequiredError}
|
|
1664
|
+
* @memberof FbaInboundApi
|
|
1665
|
+
*/
|
|
1666
|
+
updateShipmentDeliveryWindow(requestParameters: FbaInboundApiUpdateShipmentDeliveryWindowRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateShipmentDeliveryWindowResponse, any>>;
|
|
1667
|
+
/**
|
|
1668
|
+
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1669
|
+
* @param {FbaInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters.
|
|
1670
|
+
* @param {*} [options] Override http request option.
|
|
1671
|
+
* @throws {RequiredError}
|
|
1672
|
+
* @memberof FbaInboundApi
|
|
1673
|
+
*/
|
|
1674
|
+
updateShipmentTrackingDetails(requestParameters: FbaInboundApiUpdateShipmentTrackingDetailsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateShipmentTrackingDetailsResponse, any>>;
|
|
1675
|
+
}
|