@sp-api-sdk/shipping-api-v2 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +97 -0
- package/dist/cjs/index.js +18 -0
- package/dist/cjs/src/api-model/api/shipping-api.js +1203 -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/access-point-details.js +15 -0
- package/dist/cjs/src/api-model/models/access-point-type.js +31 -0
- package/dist/cjs/src/api-model/models/access-point.js +20 -0
- package/dist/cjs/src/api-model/models/accessibility-attributes.js +15 -0
- package/dist/cjs/src/api-model/models/account-status.js +27 -0
- package/dist/cjs/src/api-model/models/account-type.js +26 -0
- package/dist/cjs/src/api-model/models/active-account.js +15 -0
- package/dist/cjs/src/api-model/models/address.js +15 -0
- package/dist/cjs/src/api-model/models/amazon-order-details.js +15 -0
- package/dist/cjs/src/api-model/models/amazon-shipment-details.js +15 -0
- package/dist/cjs/src/api-model/models/available-value-added-service-group.js +15 -0
- package/dist/cjs/src/api-model/models/benefits.js +15 -0
- package/dist/cjs/src/api-model/models/cancel-shipment-response.js +15 -0
- package/dist/cjs/src/api-model/models/carrier-account-attribute.js +15 -0
- package/dist/cjs/src/api-model/models/carrier-account-input.js +15 -0
- package/dist/cjs/src/api-model/models/carrier.js +15 -0
- package/dist/cjs/src/api-model/models/channel-details.js +15 -0
- package/dist/cjs/src/api-model/models/channel-type.js +25 -0
- package/dist/cjs/src/api-model/models/charge-component.js +20 -0
- package/dist/cjs/src/api-model/models/client-reference-detail.js +20 -0
- package/dist/cjs/src/api-model/models/collect-on-delivery.js +15 -0
- package/dist/cjs/src/api-model/models/collection-forms-history-record.js +15 -0
- package/dist/cjs/src/api-model/models/collections-form-document.js +15 -0
- package/dist/cjs/src/api-model/models/currency.js +15 -0
- package/dist/cjs/src/api-model/models/dangerous-goods-details.js +36 -0
- package/dist/cjs/src/api-model/models/date-range.js +15 -0
- package/dist/cjs/src/api-model/models/dimensions.js +20 -0
- package/dist/cjs/src/api-model/models/direct-fulfillment-item-identifiers.js +15 -0
- package/dist/cjs/src/api-model/models/direct-purchase-request.js +15 -0
- package/dist/cjs/src/api-model/models/direct-purchase-response.js +15 -0
- package/dist/cjs/src/api-model/models/direct-purchase-result.js +15 -0
- package/dist/cjs/src/api-model/models/document-format.js +26 -0
- package/dist/cjs/src/api-model/models/document-size.js +20 -0
- package/dist/cjs/src/api-model/models/document-type.js +27 -0
- package/dist/cjs/src/api-model/models/error-list.js +15 -0
- package/dist/cjs/src/api-model/models/event-code.js +34 -0
- package/dist/cjs/src/api-model/models/event.js +15 -0
- package/dist/cjs/src/api-model/models/exception-operating-hours.js +15 -0
- package/dist/cjs/src/api-model/models/excluded-benefit.js +15 -0
- package/dist/cjs/src/api-model/models/generate-collection-form-request.js +15 -0
- package/dist/cjs/src/api-model/models/generate-collection-form-response.js +15 -0
- package/dist/cjs/src/api-model/models/generation-status.js +25 -0
- package/dist/cjs/src/api-model/models/geocode.js +15 -0
- package/dist/cjs/src/api-model/models/get-access-points-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-access-points-result.js +15 -0
- package/dist/cjs/src/api-model/models/get-additional-inputs-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-carrier-account-form-inputs-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-carrier-accounts-request.js +15 -0
- package/dist/cjs/src/api-model/models/get-carrier-accounts-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-collection-form-history-request.js +15 -0
- package/dist/cjs/src/api-model/models/get-collection-form-history-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-collection-form-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-rates-request.js +15 -0
- package/dist/cjs/src/api-model/models/get-rates-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-rates-result.js +15 -0
- package/dist/cjs/src/api-model/models/get-shipment-documents-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-shipment-documents-result.js +15 -0
- package/dist/cjs/src/api-model/models/get-tracking-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-tracking-result.js +15 -0
- package/dist/cjs/src/api-model/models/get-unmanifested-shipments-request.js +15 -0
- package/dist/cjs/src/api-model/models/get-unmanifested-shipments-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +130 -0
- package/dist/cjs/src/api-model/models/ineligibility-reason-code.js +33 -0
- package/dist/cjs/src/api-model/models/ineligibility-reason.js +15 -0
- package/dist/cjs/src/api-model/models/ineligible-rate.js +15 -0
- package/dist/cjs/src/api-model/models/input-type.js +25 -0
- package/dist/cjs/src/api-model/models/invoice-details.js +15 -0
- package/dist/cjs/src/api-model/models/item.js +15 -0
- package/dist/cjs/src/api-model/models/link-carrier-account-request.js +15 -0
- package/dist/cjs/src/api-model/models/link-carrier-account-response.js +15 -0
- package/dist/cjs/src/api-model/models/linkable-account-type.js +15 -0
- package/dist/cjs/src/api-model/models/linkable-carrier.js +15 -0
- package/dist/cjs/src/api-model/models/liquid-volume.js +25 -0
- package/dist/cjs/src/api-model/models/location.js +15 -0
- package/dist/cjs/src/api-model/models/model-error.js +15 -0
- package/dist/cjs/src/api-model/models/one-click-shipment-request.js +15 -0
- package/dist/cjs/src/api-model/models/one-click-shipment-response.js +15 -0
- package/dist/cjs/src/api-model/models/one-click-shipment-result.js +15 -0
- package/dist/cjs/src/api-model/models/one-click-shipment-value-added-service.js +15 -0
- package/dist/cjs/src/api-model/models/operating-hours.js +15 -0
- package/dist/cjs/src/api-model/models/package-document-detail.js +15 -0
- package/dist/cjs/src/api-model/models/package-document.js +15 -0
- package/dist/cjs/src/api-model/models/package.js +15 -0
- package/dist/cjs/src/api-model/models/payment-type.js +25 -0
- package/dist/cjs/src/api-model/models/print-option.js +15 -0
- package/dist/cjs/src/api-model/models/promise.js +15 -0
- package/dist/cjs/src/api-model/models/purchase-shipment-request.js +15 -0
- package/dist/cjs/src/api-model/models/purchase-shipment-response.js +15 -0
- package/dist/cjs/src/api-model/models/purchase-shipment-result.js +15 -0
- package/dist/cjs/src/api-model/models/rate-item-id.js +51 -0
- package/dist/cjs/src/api-model/models/rate-item-type.js +26 -0
- package/dist/cjs/src/api-model/models/rate-item.js +15 -0
- package/dist/cjs/src/api-model/models/rate.js +15 -0
- package/dist/cjs/src/api-model/models/requested-document-specification.js +15 -0
- package/dist/cjs/src/api-model/models/requested-value-added-service.js +15 -0
- package/dist/cjs/src/api-model/models/service-selection.js +15 -0
- package/dist/cjs/src/api-model/models/service.js +15 -0
- package/dist/cjs/src/api-model/models/shipment-type.js +25 -0
- package/dist/cjs/src/api-model/models/shipper-instruction.js +15 -0
- package/dist/cjs/src/api-model/models/status.js +32 -0
- package/dist/cjs/src/api-model/models/supported-document-detail.js +15 -0
- package/dist/cjs/src/api-model/models/supported-document-specification.js +15 -0
- package/dist/cjs/src/api-model/models/tax-detail.js +15 -0
- package/dist/cjs/src/api-model/models/tax-type.js +24 -0
- package/dist/cjs/src/api-model/models/time-of-day.js +15 -0
- package/dist/cjs/src/api-model/models/time-window.js +15 -0
- package/dist/cjs/src/api-model/models/tracking-summary.js +15 -0
- package/dist/cjs/src/api-model/models/unlink-carrier-account-request.js +15 -0
- package/dist/cjs/src/api-model/models/unlink-carrier-account-response.js +15 -0
- package/dist/cjs/src/api-model/models/unmanifested-carrier-information.js +15 -0
- package/dist/cjs/src/api-model/models/unmanifested-shipment-location.js +15 -0
- package/dist/cjs/src/api-model/models/validation-metadata.js +15 -0
- package/dist/cjs/src/api-model/models/value-added-service-details.js +15 -0
- package/dist/cjs/src/api-model/models/value-added-service.js +15 -0
- package/dist/cjs/src/api-model/models/weight.js +22 -0
- package/dist/cjs/src/client.js +133 -0
- package/dist/es/index.js +2 -0
- package/dist/es/src/api-model/api/shipping-api.js +1193 -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/access-point-details.js +14 -0
- package/dist/es/src/api-model/models/access-point-type.js +28 -0
- package/dist/es/src/api-model/models/access-point.js +17 -0
- package/dist/es/src/api-model/models/accessibility-attributes.js +14 -0
- package/dist/es/src/api-model/models/account-status.js +24 -0
- package/dist/es/src/api-model/models/account-type.js +23 -0
- package/dist/es/src/api-model/models/active-account.js +14 -0
- package/dist/es/src/api-model/models/address.js +14 -0
- package/dist/es/src/api-model/models/amazon-order-details.js +14 -0
- package/dist/es/src/api-model/models/amazon-shipment-details.js +14 -0
- package/dist/es/src/api-model/models/available-value-added-service-group.js +14 -0
- package/dist/es/src/api-model/models/benefits.js +14 -0
- package/dist/es/src/api-model/models/cancel-shipment-response.js +14 -0
- package/dist/es/src/api-model/models/carrier-account-attribute.js +14 -0
- package/dist/es/src/api-model/models/carrier-account-input.js +14 -0
- package/dist/es/src/api-model/models/carrier.js +14 -0
- package/dist/es/src/api-model/models/channel-details.js +14 -0
- package/dist/es/src/api-model/models/channel-type.js +22 -0
- package/dist/es/src/api-model/models/charge-component.js +17 -0
- package/dist/es/src/api-model/models/client-reference-detail.js +17 -0
- package/dist/es/src/api-model/models/collect-on-delivery.js +14 -0
- package/dist/es/src/api-model/models/collection-forms-history-record.js +14 -0
- package/dist/es/src/api-model/models/collections-form-document.js +14 -0
- package/dist/es/src/api-model/models/currency.js +14 -0
- package/dist/es/src/api-model/models/dangerous-goods-details.js +33 -0
- package/dist/es/src/api-model/models/date-range.js +14 -0
- package/dist/es/src/api-model/models/dimensions.js +17 -0
- package/dist/es/src/api-model/models/direct-fulfillment-item-identifiers.js +14 -0
- package/dist/es/src/api-model/models/direct-purchase-request.js +14 -0
- package/dist/es/src/api-model/models/direct-purchase-response.js +14 -0
- package/dist/es/src/api-model/models/direct-purchase-result.js +14 -0
- package/dist/es/src/api-model/models/document-format.js +23 -0
- package/dist/es/src/api-model/models/document-size.js +17 -0
- package/dist/es/src/api-model/models/document-type.js +24 -0
- package/dist/es/src/api-model/models/error-list.js +14 -0
- package/dist/es/src/api-model/models/event-code.js +31 -0
- package/dist/es/src/api-model/models/event.js +14 -0
- package/dist/es/src/api-model/models/exception-operating-hours.js +14 -0
- package/dist/es/src/api-model/models/excluded-benefit.js +14 -0
- package/dist/es/src/api-model/models/generate-collection-form-request.js +14 -0
- package/dist/es/src/api-model/models/generate-collection-form-response.js +14 -0
- package/dist/es/src/api-model/models/generation-status.js +22 -0
- package/dist/es/src/api-model/models/geocode.js +14 -0
- package/dist/es/src/api-model/models/get-access-points-response.js +14 -0
- package/dist/es/src/api-model/models/get-access-points-result.js +14 -0
- package/dist/es/src/api-model/models/get-additional-inputs-response.js +14 -0
- package/dist/es/src/api-model/models/get-carrier-account-form-inputs-response.js +14 -0
- package/dist/es/src/api-model/models/get-carrier-accounts-request.js +14 -0
- package/dist/es/src/api-model/models/get-carrier-accounts-response.js +14 -0
- package/dist/es/src/api-model/models/get-collection-form-history-request.js +14 -0
- package/dist/es/src/api-model/models/get-collection-form-history-response.js +14 -0
- package/dist/es/src/api-model/models/get-collection-form-response.js +14 -0
- package/dist/es/src/api-model/models/get-rates-request.js +14 -0
- package/dist/es/src/api-model/models/get-rates-response.js +14 -0
- package/dist/es/src/api-model/models/get-rates-result.js +14 -0
- package/dist/es/src/api-model/models/get-shipment-documents-response.js +14 -0
- package/dist/es/src/api-model/models/get-shipment-documents-result.js +14 -0
- package/dist/es/src/api-model/models/get-tracking-response.js +14 -0
- package/dist/es/src/api-model/models/get-tracking-result.js +14 -0
- package/dist/es/src/api-model/models/get-unmanifested-shipments-request.js +14 -0
- package/dist/es/src/api-model/models/get-unmanifested-shipments-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +114 -0
- package/dist/es/src/api-model/models/ineligibility-reason-code.js +30 -0
- package/dist/es/src/api-model/models/ineligibility-reason.js +14 -0
- package/dist/es/src/api-model/models/ineligible-rate.js +14 -0
- package/dist/es/src/api-model/models/input-type.js +22 -0
- package/dist/es/src/api-model/models/invoice-details.js +14 -0
- package/dist/es/src/api-model/models/item.js +14 -0
- package/dist/es/src/api-model/models/link-carrier-account-request.js +14 -0
- package/dist/es/src/api-model/models/link-carrier-account-response.js +14 -0
- package/dist/es/src/api-model/models/linkable-account-type.js +14 -0
- package/dist/es/src/api-model/models/linkable-carrier.js +14 -0
- package/dist/es/src/api-model/models/liquid-volume.js +22 -0
- package/dist/es/src/api-model/models/location.js +14 -0
- package/dist/es/src/api-model/models/model-error.js +14 -0
- package/dist/es/src/api-model/models/one-click-shipment-request.js +14 -0
- package/dist/es/src/api-model/models/one-click-shipment-response.js +14 -0
- package/dist/es/src/api-model/models/one-click-shipment-result.js +14 -0
- package/dist/es/src/api-model/models/one-click-shipment-value-added-service.js +14 -0
- package/dist/es/src/api-model/models/operating-hours.js +14 -0
- package/dist/es/src/api-model/models/package-document-detail.js +14 -0
- package/dist/es/src/api-model/models/package-document.js +14 -0
- package/dist/es/src/api-model/models/package.js +14 -0
- package/dist/es/src/api-model/models/payment-type.js +22 -0
- package/dist/es/src/api-model/models/print-option.js +14 -0
- package/dist/es/src/api-model/models/promise.js +14 -0
- package/dist/es/src/api-model/models/purchase-shipment-request.js +14 -0
- package/dist/es/src/api-model/models/purchase-shipment-response.js +14 -0
- package/dist/es/src/api-model/models/purchase-shipment-result.js +14 -0
- package/dist/es/src/api-model/models/rate-item-id.js +48 -0
- package/dist/es/src/api-model/models/rate-item-type.js +23 -0
- package/dist/es/src/api-model/models/rate-item.js +14 -0
- package/dist/es/src/api-model/models/rate.js +14 -0
- package/dist/es/src/api-model/models/requested-document-specification.js +14 -0
- package/dist/es/src/api-model/models/requested-value-added-service.js +14 -0
- package/dist/es/src/api-model/models/service-selection.js +14 -0
- package/dist/es/src/api-model/models/service.js +14 -0
- package/dist/es/src/api-model/models/shipment-type.js +22 -0
- package/dist/es/src/api-model/models/shipper-instruction.js +14 -0
- package/dist/es/src/api-model/models/status.js +29 -0
- package/dist/es/src/api-model/models/supported-document-detail.js +14 -0
- package/dist/es/src/api-model/models/supported-document-specification.js +14 -0
- package/dist/es/src/api-model/models/tax-detail.js +14 -0
- package/dist/es/src/api-model/models/tax-type.js +21 -0
- package/dist/es/src/api-model/models/time-of-day.js +14 -0
- package/dist/es/src/api-model/models/time-window.js +14 -0
- package/dist/es/src/api-model/models/tracking-summary.js +14 -0
- package/dist/es/src/api-model/models/unlink-carrier-account-request.js +14 -0
- package/dist/es/src/api-model/models/unlink-carrier-account-response.js +14 -0
- package/dist/es/src/api-model/models/unmanifested-carrier-information.js +14 -0
- package/dist/es/src/api-model/models/unmanifested-shipment-location.js +14 -0
- package/dist/es/src/api-model/models/validation-metadata.js +14 -0
- package/dist/es/src/api-model/models/value-added-service-details.js +14 -0
- package/dist/es/src/api-model/models/value-added-service.js +14 -0
- package/dist/es/src/api-model/models/weight.js +19 -0
- package/dist/es/src/client.js +129 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/src/api-model/api/shipping-api.d.ts +1014 -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/access-point-details.d.ts +24 -0
- package/dist/types/src/api-model/models/access-point-type.d.ts +27 -0
- package/dist/types/src/api-model/models/access-point.d.ts +90 -0
- package/dist/types/src/api-model/models/accessibility-attributes.d.ts +30 -0
- package/dist/types/src/api-model/models/account-status.d.ts +23 -0
- package/dist/types/src/api-model/models/account-type.d.ts +22 -0
- package/dist/types/src/api-model/models/active-account.d.ts +30 -0
- package/dist/types/src/api-model/models/address.d.ts +91 -0
- package/dist/types/src/api-model/models/amazon-order-details.d.ts +24 -0
- package/dist/types/src/api-model/models/amazon-shipment-details.d.ts +24 -0
- package/dist/types/src/api-model/models/available-value-added-service-group.d.ts +43 -0
- package/dist/types/src/api-model/models/benefits.d.ts +31 -0
- package/dist/types/src/api-model/models/cancel-shipment-response.d.ts +26 -0
- package/dist/types/src/api-model/models/carrier-account-attribute.d.ts +36 -0
- package/dist/types/src/api-model/models/carrier-account-input.d.ts +68 -0
- package/dist/types/src/api-model/models/carrier.d.ts +30 -0
- package/dist/types/src/api-model/models/channel-details.d.ts +39 -0
- package/dist/types/src/api-model/models/channel-type.d.ts +21 -0
- package/dist/types/src/api-model/models/charge-component.d.ts +36 -0
- package/dist/types/src/api-model/models/client-reference-detail.d.ts +35 -0
- package/dist/types/src/api-model/models/collect-on-delivery.d.ts +25 -0
- package/dist/types/src/api-model/models/collection-forms-history-record.d.ts +50 -0
- package/dist/types/src/api-model/models/collections-form-document.d.ts +30 -0
- package/dist/types/src/api-model/models/currency.d.ts +30 -0
- package/dist/types/src/api-model/models/dangerous-goods-details.d.ts +64 -0
- package/dist/types/src/api-model/models/date-range.d.ts +30 -0
- package/dist/types/src/api-model/models/dimensions.d.ts +47 -0
- package/dist/types/src/api-model/models/direct-fulfillment-item-identifiers.d.ts +30 -0
- package/dist/types/src/api-model/models/direct-purchase-request.d.ts +58 -0
- package/dist/types/src/api-model/models/direct-purchase-response.d.ts +25 -0
- package/dist/types/src/api-model/models/direct-purchase-result.d.ts +31 -0
- package/dist/types/src/api-model/models/document-format.d.ts +22 -0
- package/dist/types/src/api-model/models/document-size.d.ts +41 -0
- package/dist/types/src/api-model/models/document-type.d.ts +23 -0
- package/dist/types/src/api-model/models/error-list.d.ts +24 -0
- package/dist/types/src/api-model/models/event-code.d.ts +30 -0
- package/dist/types/src/api-model/models/event.d.ts +38 -0
- package/dist/types/src/api-model/models/exception-operating-hours.d.ts +32 -0
- package/dist/types/src/api-model/models/excluded-benefit.d.ts +30 -0
- package/dist/types/src/api-model/models/generate-collection-form-request.d.ts +38 -0
- package/dist/types/src/api-model/models/generate-collection-form-response.d.ts +25 -0
- package/dist/types/src/api-model/models/generation-status.d.ts +21 -0
- package/dist/types/src/api-model/models/geocode.d.ts +30 -0
- package/dist/types/src/api-model/models/get-access-points-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-access-points-result.d.ts +27 -0
- package/dist/types/src/api-model/models/get-additional-inputs-response.d.ts +26 -0
- package/dist/types/src/api-model/models/get-carrier-account-form-inputs-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-carrier-accounts-request.d.ts +25 -0
- package/dist/types/src/api-model/models/get-carrier-accounts-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-collection-form-history-request.d.ts +51 -0
- package/dist/types/src/api-model/models/get-collection-form-history-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-collection-form-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-rates-request.d.ts +99 -0
- package/dist/types/src/api-model/models/get-rates-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-rates-result.d.ts +38 -0
- package/dist/types/src/api-model/models/get-shipment-documents-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-shipment-documents-result.d.ts +31 -0
- package/dist/types/src/api-model/models/get-tracking-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-tracking-result.d.ts +50 -0
- package/dist/types/src/api-model/models/get-unmanifested-shipments-request.d.ts +25 -0
- package/dist/types/src/api-model/models/get-unmanifested-shipments-response.d.ts +25 -0
- package/dist/types/src/api-model/models/index.d.ts +114 -0
- package/dist/types/src/api-model/models/ineligibility-reason-code.d.ts +29 -0
- package/dist/types/src/api-model/models/ineligibility-reason.d.ts +31 -0
- package/dist/types/src/api-model/models/ineligible-rate.d.ts +49 -0
- package/dist/types/src/api-model/models/input-type.d.ts +21 -0
- package/dist/types/src/api-model/models/invoice-details.d.ts +30 -0
- package/dist/types/src/api-model/models/item.d.ts +96 -0
- package/dist/types/src/api-model/models/link-carrier-account-request.d.ts +44 -0
- package/dist/types/src/api-model/models/link-carrier-account-response.d.ts +25 -0
- package/dist/types/src/api-model/models/linkable-account-type.d.ts +32 -0
- package/dist/types/src/api-model/models/linkable-carrier.d.ts +31 -0
- package/dist/types/src/api-model/models/liquid-volume.d.ts +40 -0
- package/dist/types/src/api-model/models/location.d.ts +42 -0
- package/dist/types/src/api-model/models/model-error.d.ts +36 -0
- package/dist/types/src/api-model/models/one-click-shipment-request.d.ts +99 -0
- package/dist/types/src/api-model/models/one-click-shipment-response.d.ts +25 -0
- package/dist/types/src/api-model/models/one-click-shipment-result.d.ts +59 -0
- package/dist/types/src/api-model/models/one-click-shipment-value-added-service.d.ts +31 -0
- package/dist/types/src/api-model/models/operating-hours.d.ts +37 -0
- package/dist/types/src/api-model/models/package-document-detail.d.ts +37 -0
- package/dist/types/src/api-model/models/package-document.d.ts +38 -0
- package/dist/types/src/api-model/models/package.d.ts +71 -0
- package/dist/types/src/api-model/models/payment-type.d.ts +21 -0
- package/dist/types/src/api-model/models/print-option.d.ts +43 -0
- package/dist/types/src/api-model/models/promise.d.ts +31 -0
- package/dist/types/src/api-model/models/purchase-shipment-request.d.ts +52 -0
- package/dist/types/src/api-model/models/purchase-shipment-response.d.ts +25 -0
- package/dist/types/src/api-model/models/purchase-shipment-result.d.ts +38 -0
- package/dist/types/src/api-model/models/rate-item-id.d.ts +47 -0
- package/dist/types/src/api-model/models/rate-item-type.d.ts +22 -0
- package/dist/types/src/api-model/models/rate-item.d.ts +45 -0
- package/dist/types/src/api-model/models/rate.d.ts +110 -0
- package/dist/types/src/api-model/models/requested-document-specification.d.ts +57 -0
- package/dist/types/src/api-model/models/requested-value-added-service.d.ts +24 -0
- package/dist/types/src/api-model/models/service-selection.d.ts +24 -0
- package/dist/types/src/api-model/models/service.d.ts +30 -0
- package/dist/types/src/api-model/models/shipment-type.d.ts +21 -0
- package/dist/types/src/api-model/models/shipper-instruction.d.ts +24 -0
- package/dist/types/src/api-model/models/status.d.ts +28 -0
- package/dist/types/src/api-model/models/supported-document-detail.d.ts +31 -0
- package/dist/types/src/api-model/models/supported-document-specification.d.ts +39 -0
- package/dist/types/src/api-model/models/tax-detail.d.ts +31 -0
- package/dist/types/src/api-model/models/tax-type.d.ts +20 -0
- package/dist/types/src/api-model/models/time-of-day.d.ts +36 -0
- package/dist/types/src/api-model/models/time-window.d.ts +30 -0
- package/dist/types/src/api-model/models/tracking-summary.d.ts +25 -0
- package/dist/types/src/api-model/models/unlink-carrier-account-request.d.ts +25 -0
- package/dist/types/src/api-model/models/unlink-carrier-account-response.d.ts +24 -0
- package/dist/types/src/api-model/models/unmanifested-carrier-information.d.ts +37 -0
- package/dist/types/src/api-model/models/unmanifested-shipment-location.d.ts +31 -0
- package/dist/types/src/api-model/models/validation-metadata.d.ts +36 -0
- package/dist/types/src/api-model/models/value-added-service-details.d.ts +25 -0
- package/dist/types/src/api-model/models/value-added-service.d.ts +37 -0
- package/dist/types/src/api-model/models/weight.d.ts +37 -0
- package/dist/types/src/client.d.ts +6 -0
- package/package.json +44 -0
|
@@ -0,0 +1,1193 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Amazon Shipping API
|
|
5
|
+
* The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v2
|
|
8
|
+
* Contact: swa-api-core@amazon.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
// Some imports not used depending on template conditions
|
|
16
|
+
// @ts-ignore
|
|
17
|
+
import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
18
|
+
// @ts-ignore
|
|
19
|
+
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
|
|
20
|
+
/**
|
|
21
|
+
* ShippingApi - axios parameter creator
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export const ShippingApiAxiosParamCreator = function (configuration) {
|
|
25
|
+
return {
|
|
26
|
+
/**
|
|
27
|
+
* Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
28
|
+
* @param {string} shipmentId The shipment identifier originally returned by the purchaseShipment operation.
|
|
29
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
30
|
+
* @param {*} [options] Override http request option.
|
|
31
|
+
* @throws {RequiredError}
|
|
32
|
+
*/
|
|
33
|
+
cancelShipment: async (shipmentId, xAmznShippingBusinessId, options = {}) => {
|
|
34
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
35
|
+
assertParamExists('cancelShipment', 'shipmentId', shipmentId);
|
|
36
|
+
const localVarPath = `/shipping/v2/shipments/{shipmentId}/cancel`
|
|
37
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
38
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
39
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40
|
+
let baseOptions;
|
|
41
|
+
if (configuration) {
|
|
42
|
+
baseOptions = configuration.baseOptions;
|
|
43
|
+
}
|
|
44
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
45
|
+
const localVarHeaderParameter = {};
|
|
46
|
+
const localVarQueryParameter = {};
|
|
47
|
+
if (xAmznShippingBusinessId != null) {
|
|
48
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
49
|
+
}
|
|
50
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
52
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
53
|
+
return {
|
|
54
|
+
url: toPathString(localVarUrlObj),
|
|
55
|
+
options: localVarRequestOptions,
|
|
56
|
+
};
|
|
57
|
+
},
|
|
58
|
+
/**
|
|
59
|
+
* Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
60
|
+
* @param {DirectPurchaseRequest} body
|
|
61
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
62
|
+
* @param {string} [locale] The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags.
|
|
63
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
directPurchaseShipment: async (body, xAmznIdempotencyKey, locale, xAmznShippingBusinessId, options = {}) => {
|
|
68
|
+
// verify required parameter 'body' is not null or undefined
|
|
69
|
+
assertParamExists('directPurchaseShipment', 'body', body);
|
|
70
|
+
const localVarPath = `/shipping/v2/shipments/directPurchase`;
|
|
71
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
72
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
73
|
+
let baseOptions;
|
|
74
|
+
if (configuration) {
|
|
75
|
+
baseOptions = configuration.baseOptions;
|
|
76
|
+
}
|
|
77
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
78
|
+
const localVarHeaderParameter = {};
|
|
79
|
+
const localVarQueryParameter = {};
|
|
80
|
+
if (xAmznIdempotencyKey != null) {
|
|
81
|
+
localVarHeaderParameter['x-amzn-IdempotencyKey'] = String(xAmznIdempotencyKey);
|
|
82
|
+
}
|
|
83
|
+
if (locale != null) {
|
|
84
|
+
localVarHeaderParameter['locale'] = String(locale);
|
|
85
|
+
}
|
|
86
|
+
if (xAmznShippingBusinessId != null) {
|
|
87
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
88
|
+
}
|
|
89
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
90
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
91
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
92
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
93
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
94
|
+
return {
|
|
95
|
+
url: toPathString(localVarUrlObj),
|
|
96
|
+
options: localVarRequestOptions,
|
|
97
|
+
};
|
|
98
|
+
},
|
|
99
|
+
/**
|
|
100
|
+
* This API Call to generate the collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
101
|
+
* @param {GenerateCollectionFormRequest} body
|
|
102
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
103
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
104
|
+
* @param {*} [options] Override http request option.
|
|
105
|
+
* @throws {RequiredError}
|
|
106
|
+
*/
|
|
107
|
+
generateCollectionForm: async (body, xAmznIdempotencyKey, xAmznShippingBusinessId, options = {}) => {
|
|
108
|
+
// verify required parameter 'body' is not null or undefined
|
|
109
|
+
assertParamExists('generateCollectionForm', 'body', body);
|
|
110
|
+
const localVarPath = `/shipping/v2/collectionForms`;
|
|
111
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
112
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
113
|
+
let baseOptions;
|
|
114
|
+
if (configuration) {
|
|
115
|
+
baseOptions = configuration.baseOptions;
|
|
116
|
+
}
|
|
117
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
118
|
+
const localVarHeaderParameter = {};
|
|
119
|
+
const localVarQueryParameter = {};
|
|
120
|
+
if (xAmznIdempotencyKey != null) {
|
|
121
|
+
localVarHeaderParameter['x-amzn-IdempotencyKey'] = String(xAmznIdempotencyKey);
|
|
122
|
+
}
|
|
123
|
+
if (xAmznShippingBusinessId != null) {
|
|
124
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
125
|
+
}
|
|
126
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
127
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
128
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
129
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
130
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
131
|
+
return {
|
|
132
|
+
url: toPathString(localVarUrlObj),
|
|
133
|
+
options: localVarRequestOptions,
|
|
134
|
+
};
|
|
135
|
+
},
|
|
136
|
+
/**
|
|
137
|
+
* Returns a list of access points in proximity of input postal code. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
138
|
+
* @param {Array<'HELIX' | 'CAMPUS_LOCKER' | 'OMNI_LOCKER' | 'ODIN_LOCKER' | 'DOBBY_LOCKER' | 'CORE_LOCKER' | '3P' | 'CAMPUS_ROOM'>} accessPointTypes
|
|
139
|
+
* @param {string} countryCode
|
|
140
|
+
* @param {string} postalCode
|
|
141
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
142
|
+
* @param {*} [options] Override http request option.
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
getAccessPoints: async (accessPointTypes, countryCode, postalCode, xAmznShippingBusinessId, options = {}) => {
|
|
146
|
+
// verify required parameter 'accessPointTypes' is not null or undefined
|
|
147
|
+
assertParamExists('getAccessPoints', 'accessPointTypes', accessPointTypes);
|
|
148
|
+
// verify required parameter 'countryCode' is not null or undefined
|
|
149
|
+
assertParamExists('getAccessPoints', 'countryCode', countryCode);
|
|
150
|
+
// verify required parameter 'postalCode' is not null or undefined
|
|
151
|
+
assertParamExists('getAccessPoints', 'postalCode', postalCode);
|
|
152
|
+
const localVarPath = `/shipping/v2/accessPoints`;
|
|
153
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
154
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
155
|
+
let baseOptions;
|
|
156
|
+
if (configuration) {
|
|
157
|
+
baseOptions = configuration.baseOptions;
|
|
158
|
+
}
|
|
159
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
160
|
+
const localVarHeaderParameter = {};
|
|
161
|
+
const localVarQueryParameter = {};
|
|
162
|
+
if (accessPointTypes) {
|
|
163
|
+
localVarQueryParameter['accessPointTypes'] = accessPointTypes.join(COLLECTION_FORMATS.csv);
|
|
164
|
+
}
|
|
165
|
+
if (countryCode !== undefined) {
|
|
166
|
+
localVarQueryParameter['countryCode'] = countryCode;
|
|
167
|
+
}
|
|
168
|
+
if (postalCode !== undefined) {
|
|
169
|
+
localVarQueryParameter['postalCode'] = postalCode;
|
|
170
|
+
}
|
|
171
|
+
if (xAmznShippingBusinessId != null) {
|
|
172
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
173
|
+
}
|
|
174
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
175
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
176
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
177
|
+
return {
|
|
178
|
+
url: toPathString(localVarUrlObj),
|
|
179
|
+
options: localVarRequestOptions,
|
|
180
|
+
};
|
|
181
|
+
},
|
|
182
|
+
/**
|
|
183
|
+
* Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
184
|
+
* @param {string} requestToken The request token returned in the response to the getRates operation.
|
|
185
|
+
* @param {string} rateId The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.
|
|
186
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
getAdditionalInputs: async (requestToken, rateId, xAmznShippingBusinessId, options = {}) => {
|
|
191
|
+
// verify required parameter 'requestToken' is not null or undefined
|
|
192
|
+
assertParamExists('getAdditionalInputs', 'requestToken', requestToken);
|
|
193
|
+
// verify required parameter 'rateId' is not null or undefined
|
|
194
|
+
assertParamExists('getAdditionalInputs', 'rateId', rateId);
|
|
195
|
+
const localVarPath = `/shipping/v2/shipments/additionalInputs/schema`;
|
|
196
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
197
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
198
|
+
let baseOptions;
|
|
199
|
+
if (configuration) {
|
|
200
|
+
baseOptions = configuration.baseOptions;
|
|
201
|
+
}
|
|
202
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
203
|
+
const localVarHeaderParameter = {};
|
|
204
|
+
const localVarQueryParameter = {};
|
|
205
|
+
if (requestToken !== undefined) {
|
|
206
|
+
localVarQueryParameter['requestToken'] = requestToken;
|
|
207
|
+
}
|
|
208
|
+
if (rateId !== undefined) {
|
|
209
|
+
localVarQueryParameter['rateId'] = rateId;
|
|
210
|
+
}
|
|
211
|
+
if (xAmznShippingBusinessId != null) {
|
|
212
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
213
|
+
}
|
|
214
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
215
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
216
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
217
|
+
return {
|
|
218
|
+
url: toPathString(localVarUrlObj),
|
|
219
|
+
options: localVarRequestOptions,
|
|
220
|
+
};
|
|
221
|
+
},
|
|
222
|
+
/**
|
|
223
|
+
* This API will return a list of input schema required to register a shipper account with the carrier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
224
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
225
|
+
* @param {*} [options] Override http request option.
|
|
226
|
+
* @throws {RequiredError}
|
|
227
|
+
*/
|
|
228
|
+
getCarrierAccountFormInputs: async (xAmznShippingBusinessId, options = {}) => {
|
|
229
|
+
const localVarPath = `/shipping/v2/carrierAccountFormInputs`;
|
|
230
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
231
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
232
|
+
let baseOptions;
|
|
233
|
+
if (configuration) {
|
|
234
|
+
baseOptions = configuration.baseOptions;
|
|
235
|
+
}
|
|
236
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
237
|
+
const localVarHeaderParameter = {};
|
|
238
|
+
const localVarQueryParameter = {};
|
|
239
|
+
if (xAmznShippingBusinessId != null) {
|
|
240
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
241
|
+
}
|
|
242
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
243
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
244
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
245
|
+
return {
|
|
246
|
+
url: toPathString(localVarUrlObj),
|
|
247
|
+
options: localVarRequestOptions,
|
|
248
|
+
};
|
|
249
|
+
},
|
|
250
|
+
/**
|
|
251
|
+
* This API will return Get all carrier accounts for a merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
252
|
+
* @param {GetCarrierAccountsRequest} body
|
|
253
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
254
|
+
* @param {*} [options] Override http request option.
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
*/
|
|
257
|
+
getCarrierAccounts: async (body, xAmznShippingBusinessId, options = {}) => {
|
|
258
|
+
// verify required parameter 'body' is not null or undefined
|
|
259
|
+
assertParamExists('getCarrierAccounts', 'body', body);
|
|
260
|
+
const localVarPath = `/shipping/v2/carrierAccounts`;
|
|
261
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
262
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
263
|
+
let baseOptions;
|
|
264
|
+
if (configuration) {
|
|
265
|
+
baseOptions = configuration.baseOptions;
|
|
266
|
+
}
|
|
267
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
268
|
+
const localVarHeaderParameter = {};
|
|
269
|
+
const localVarQueryParameter = {};
|
|
270
|
+
if (xAmznShippingBusinessId != null) {
|
|
271
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
272
|
+
}
|
|
273
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
274
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
275
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
276
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
277
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
278
|
+
return {
|
|
279
|
+
url: toPathString(localVarUrlObj),
|
|
280
|
+
options: localVarRequestOptions,
|
|
281
|
+
};
|
|
282
|
+
},
|
|
283
|
+
/**
|
|
284
|
+
* This API reprint a collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
285
|
+
* @param {string} collectionFormId collection form Id to reprint a collection.
|
|
286
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
287
|
+
* @param {*} [options] Override http request option.
|
|
288
|
+
* @throws {RequiredError}
|
|
289
|
+
*/
|
|
290
|
+
getCollectionForm: async (collectionFormId, xAmznShippingBusinessId, options = {}) => {
|
|
291
|
+
// verify required parameter 'collectionFormId' is not null or undefined
|
|
292
|
+
assertParamExists('getCollectionForm', 'collectionFormId', collectionFormId);
|
|
293
|
+
const localVarPath = `/shipping/v2/collectionForms/{collectionFormId}`
|
|
294
|
+
.replace(`{${"collectionFormId"}}`, encodeURIComponent(String(collectionFormId)));
|
|
295
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
296
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
297
|
+
let baseOptions;
|
|
298
|
+
if (configuration) {
|
|
299
|
+
baseOptions = configuration.baseOptions;
|
|
300
|
+
}
|
|
301
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
302
|
+
const localVarHeaderParameter = {};
|
|
303
|
+
const localVarQueryParameter = {};
|
|
304
|
+
if (xAmznShippingBusinessId != null) {
|
|
305
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
306
|
+
}
|
|
307
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
308
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
309
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
310
|
+
return {
|
|
311
|
+
url: toPathString(localVarUrlObj),
|
|
312
|
+
options: localVarRequestOptions,
|
|
313
|
+
};
|
|
314
|
+
},
|
|
315
|
+
/**
|
|
316
|
+
* This API Call to get the history of the previously generated collection forms. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
317
|
+
* @param {GetCollectionFormHistoryRequest} body
|
|
318
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
319
|
+
* @param {*} [options] Override http request option.
|
|
320
|
+
* @throws {RequiredError}
|
|
321
|
+
*/
|
|
322
|
+
getCollectionFormHistory: async (body, xAmznShippingBusinessId, options = {}) => {
|
|
323
|
+
// verify required parameter 'body' is not null or undefined
|
|
324
|
+
assertParamExists('getCollectionFormHistory', 'body', body);
|
|
325
|
+
const localVarPath = `/shipping/v2/collectionForms/history`;
|
|
326
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
327
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
328
|
+
let baseOptions;
|
|
329
|
+
if (configuration) {
|
|
330
|
+
baseOptions = configuration.baseOptions;
|
|
331
|
+
}
|
|
332
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
333
|
+
const localVarHeaderParameter = {};
|
|
334
|
+
const localVarQueryParameter = {};
|
|
335
|
+
if (xAmznShippingBusinessId != null) {
|
|
336
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
337
|
+
}
|
|
338
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
339
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
340
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
341
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
342
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
343
|
+
return {
|
|
344
|
+
url: toPathString(localVarUrlObj),
|
|
345
|
+
options: localVarRequestOptions,
|
|
346
|
+
};
|
|
347
|
+
},
|
|
348
|
+
/**
|
|
349
|
+
* Returns the available shipping service offerings. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
350
|
+
* @param {GetRatesRequest} body
|
|
351
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
*/
|
|
355
|
+
getRates: async (body, xAmznShippingBusinessId, options = {}) => {
|
|
356
|
+
// verify required parameter 'body' is not null or undefined
|
|
357
|
+
assertParamExists('getRates', 'body', body);
|
|
358
|
+
const localVarPath = `/shipping/v2/shipments/rates`;
|
|
359
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
360
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
361
|
+
let baseOptions;
|
|
362
|
+
if (configuration) {
|
|
363
|
+
baseOptions = configuration.baseOptions;
|
|
364
|
+
}
|
|
365
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
366
|
+
const localVarHeaderParameter = {};
|
|
367
|
+
const localVarQueryParameter = {};
|
|
368
|
+
if (xAmznShippingBusinessId != null) {
|
|
369
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
370
|
+
}
|
|
371
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
372
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
373
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
374
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
375
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
376
|
+
return {
|
|
377
|
+
url: toPathString(localVarUrlObj),
|
|
378
|
+
options: localVarRequestOptions,
|
|
379
|
+
};
|
|
380
|
+
},
|
|
381
|
+
/**
|
|
382
|
+
* Returns the shipping documents associated with a package in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
383
|
+
* @param {string} shipmentId The shipment identifier originally returned by the purchaseShipment operation.
|
|
384
|
+
* @param {string} packageClientReferenceId The package client reference identifier originally provided in the request body parameter for the getRates operation.
|
|
385
|
+
* @param {string} [format] The file format of the document. Must be one of the supported formats returned by the getRates operation.
|
|
386
|
+
* @param {number} [dpi] The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.
|
|
387
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
388
|
+
* @param {*} [options] Override http request option.
|
|
389
|
+
* @throws {RequiredError}
|
|
390
|
+
*/
|
|
391
|
+
getShipmentDocuments: async (shipmentId, packageClientReferenceId, format, dpi, xAmznShippingBusinessId, options = {}) => {
|
|
392
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
393
|
+
assertParamExists('getShipmentDocuments', 'shipmentId', shipmentId);
|
|
394
|
+
// verify required parameter 'packageClientReferenceId' is not null or undefined
|
|
395
|
+
assertParamExists('getShipmentDocuments', 'packageClientReferenceId', packageClientReferenceId);
|
|
396
|
+
const localVarPath = `/shipping/v2/shipments/{shipmentId}/documents`
|
|
397
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
398
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
399
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
400
|
+
let baseOptions;
|
|
401
|
+
if (configuration) {
|
|
402
|
+
baseOptions = configuration.baseOptions;
|
|
403
|
+
}
|
|
404
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
405
|
+
const localVarHeaderParameter = {};
|
|
406
|
+
const localVarQueryParameter = {};
|
|
407
|
+
if (packageClientReferenceId !== undefined) {
|
|
408
|
+
localVarQueryParameter['packageClientReferenceId'] = packageClientReferenceId;
|
|
409
|
+
}
|
|
410
|
+
if (format !== undefined) {
|
|
411
|
+
localVarQueryParameter['format'] = format;
|
|
412
|
+
}
|
|
413
|
+
if (dpi !== undefined) {
|
|
414
|
+
localVarQueryParameter['dpi'] = dpi;
|
|
415
|
+
}
|
|
416
|
+
if (xAmznShippingBusinessId != null) {
|
|
417
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
418
|
+
}
|
|
419
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
420
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
421
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
422
|
+
return {
|
|
423
|
+
url: toPathString(localVarUrlObj),
|
|
424
|
+
options: localVarRequestOptions,
|
|
425
|
+
};
|
|
426
|
+
},
|
|
427
|
+
/**
|
|
428
|
+
* Returns tracking information for a purchased shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
429
|
+
* @param {string} trackingId A carrier-generated tracking identifier originally returned by the purchaseShipment operation.
|
|
430
|
+
* @param {string} carrierId A carrier identifier originally returned by the getRates operation for the selected rate.
|
|
431
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
432
|
+
* @param {*} [options] Override http request option.
|
|
433
|
+
* @throws {RequiredError}
|
|
434
|
+
*/
|
|
435
|
+
getTracking: async (trackingId, carrierId, xAmznShippingBusinessId, options = {}) => {
|
|
436
|
+
// verify required parameter 'trackingId' is not null or undefined
|
|
437
|
+
assertParamExists('getTracking', 'trackingId', trackingId);
|
|
438
|
+
// verify required parameter 'carrierId' is not null or undefined
|
|
439
|
+
assertParamExists('getTracking', 'carrierId', carrierId);
|
|
440
|
+
const localVarPath = `/shipping/v2/tracking`;
|
|
441
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
442
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
443
|
+
let baseOptions;
|
|
444
|
+
if (configuration) {
|
|
445
|
+
baseOptions = configuration.baseOptions;
|
|
446
|
+
}
|
|
447
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
448
|
+
const localVarHeaderParameter = {};
|
|
449
|
+
const localVarQueryParameter = {};
|
|
450
|
+
if (trackingId !== undefined) {
|
|
451
|
+
localVarQueryParameter['trackingId'] = trackingId;
|
|
452
|
+
}
|
|
453
|
+
if (carrierId !== undefined) {
|
|
454
|
+
localVarQueryParameter['carrierId'] = carrierId;
|
|
455
|
+
}
|
|
456
|
+
if (xAmznShippingBusinessId != null) {
|
|
457
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
458
|
+
}
|
|
459
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
460
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
461
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
462
|
+
return {
|
|
463
|
+
url: toPathString(localVarUrlObj),
|
|
464
|
+
options: localVarRequestOptions,
|
|
465
|
+
};
|
|
466
|
+
},
|
|
467
|
+
/**
|
|
468
|
+
* This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
469
|
+
* @param {GetUnmanifestedShipmentsRequest} body
|
|
470
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
471
|
+
* @param {*} [options] Override http request option.
|
|
472
|
+
* @throws {RequiredError}
|
|
473
|
+
*/
|
|
474
|
+
getUnmanifestedShipments: async (body, xAmznShippingBusinessId, options = {}) => {
|
|
475
|
+
// verify required parameter 'body' is not null or undefined
|
|
476
|
+
assertParamExists('getUnmanifestedShipments', 'body', body);
|
|
477
|
+
const localVarPath = `/shipping/v2/unmanifestedShipments`;
|
|
478
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
479
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
480
|
+
let baseOptions;
|
|
481
|
+
if (configuration) {
|
|
482
|
+
baseOptions = configuration.baseOptions;
|
|
483
|
+
}
|
|
484
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
485
|
+
const localVarHeaderParameter = {};
|
|
486
|
+
const localVarQueryParameter = {};
|
|
487
|
+
if (xAmznShippingBusinessId != null) {
|
|
488
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
489
|
+
}
|
|
490
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
491
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
492
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
493
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
494
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
495
|
+
return {
|
|
496
|
+
url: toPathString(localVarUrlObj),
|
|
497
|
+
options: localVarRequestOptions,
|
|
498
|
+
};
|
|
499
|
+
},
|
|
500
|
+
/**
|
|
501
|
+
* This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
502
|
+
* @param {string} carrierId The unique identifier associated with the carrier account.
|
|
503
|
+
* @param {LinkCarrierAccountRequest} body
|
|
504
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
505
|
+
* @param {*} [options] Override http request option.
|
|
506
|
+
* @throws {RequiredError}
|
|
507
|
+
*/
|
|
508
|
+
linkCarrierAccount: async (carrierId, body, xAmznShippingBusinessId, options = {}) => {
|
|
509
|
+
// verify required parameter 'carrierId' is not null or undefined
|
|
510
|
+
assertParamExists('linkCarrierAccount', 'carrierId', carrierId);
|
|
511
|
+
// verify required parameter 'body' is not null or undefined
|
|
512
|
+
assertParamExists('linkCarrierAccount', 'body', body);
|
|
513
|
+
const localVarPath = `/shipping/v2/carrierAccounts/{carrierId}`
|
|
514
|
+
.replace(`{${"carrierId"}}`, encodeURIComponent(String(carrierId)));
|
|
515
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
516
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
517
|
+
let baseOptions;
|
|
518
|
+
if (configuration) {
|
|
519
|
+
baseOptions = configuration.baseOptions;
|
|
520
|
+
}
|
|
521
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
522
|
+
const localVarHeaderParameter = {};
|
|
523
|
+
const localVarQueryParameter = {};
|
|
524
|
+
if (xAmznShippingBusinessId != null) {
|
|
525
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
526
|
+
}
|
|
527
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
528
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
529
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
530
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
531
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
532
|
+
return {
|
|
533
|
+
url: toPathString(localVarUrlObj),
|
|
534
|
+
options: localVarRequestOptions,
|
|
535
|
+
};
|
|
536
|
+
},
|
|
537
|
+
/**
|
|
538
|
+
* Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
539
|
+
* @param {OneClickShipmentRequest} body
|
|
540
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
541
|
+
* @param {*} [options] Override http request option.
|
|
542
|
+
* @throws {RequiredError}
|
|
543
|
+
*/
|
|
544
|
+
oneClickShipment: async (body, xAmznShippingBusinessId, options = {}) => {
|
|
545
|
+
// verify required parameter 'body' is not null or undefined
|
|
546
|
+
assertParamExists('oneClickShipment', 'body', body);
|
|
547
|
+
const localVarPath = `/shipping/v2/oneClickShipment`;
|
|
548
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
549
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
550
|
+
let baseOptions;
|
|
551
|
+
if (configuration) {
|
|
552
|
+
baseOptions = configuration.baseOptions;
|
|
553
|
+
}
|
|
554
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
555
|
+
const localVarHeaderParameter = {};
|
|
556
|
+
const localVarQueryParameter = {};
|
|
557
|
+
if (xAmznShippingBusinessId != null) {
|
|
558
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
559
|
+
}
|
|
560
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
561
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
562
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
563
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
564
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
565
|
+
return {
|
|
566
|
+
url: toPathString(localVarUrlObj),
|
|
567
|
+
options: localVarRequestOptions,
|
|
568
|
+
};
|
|
569
|
+
},
|
|
570
|
+
/**
|
|
571
|
+
* Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
572
|
+
* @param {PurchaseShipmentRequest} body
|
|
573
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
574
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
575
|
+
* @param {*} [options] Override http request option.
|
|
576
|
+
* @throws {RequiredError}
|
|
577
|
+
*/
|
|
578
|
+
purchaseShipment: async (body, xAmznIdempotencyKey, xAmznShippingBusinessId, options = {}) => {
|
|
579
|
+
// verify required parameter 'body' is not null or undefined
|
|
580
|
+
assertParamExists('purchaseShipment', 'body', body);
|
|
581
|
+
const localVarPath = `/shipping/v2/shipments`;
|
|
582
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
583
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
584
|
+
let baseOptions;
|
|
585
|
+
if (configuration) {
|
|
586
|
+
baseOptions = configuration.baseOptions;
|
|
587
|
+
}
|
|
588
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
589
|
+
const localVarHeaderParameter = {};
|
|
590
|
+
const localVarQueryParameter = {};
|
|
591
|
+
if (xAmznIdempotencyKey != null) {
|
|
592
|
+
localVarHeaderParameter['x-amzn-IdempotencyKey'] = String(xAmznIdempotencyKey);
|
|
593
|
+
}
|
|
594
|
+
if (xAmznShippingBusinessId != null) {
|
|
595
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
596
|
+
}
|
|
597
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
598
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
599
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
600
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
601
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
602
|
+
return {
|
|
603
|
+
url: toPathString(localVarUrlObj),
|
|
604
|
+
options: localVarRequestOptions,
|
|
605
|
+
};
|
|
606
|
+
},
|
|
607
|
+
/**
|
|
608
|
+
* This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
609
|
+
* @param {string} carrierId carrier Id to unlink with merchant.
|
|
610
|
+
* @param {UnlinkCarrierAccountRequest} body
|
|
611
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
612
|
+
* @param {*} [options] Override http request option.
|
|
613
|
+
* @throws {RequiredError}
|
|
614
|
+
*/
|
|
615
|
+
unlinkCarrierAccount: async (carrierId, body, xAmznShippingBusinessId, options = {}) => {
|
|
616
|
+
// verify required parameter 'carrierId' is not null or undefined
|
|
617
|
+
assertParamExists('unlinkCarrierAccount', 'carrierId', carrierId);
|
|
618
|
+
// verify required parameter 'body' is not null or undefined
|
|
619
|
+
assertParamExists('unlinkCarrierAccount', 'body', body);
|
|
620
|
+
const localVarPath = `/shipping/v2/carrierAccounts/{carrierId}/unlink`
|
|
621
|
+
.replace(`{${"carrierId"}}`, encodeURIComponent(String(carrierId)));
|
|
622
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
623
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
624
|
+
let baseOptions;
|
|
625
|
+
if (configuration) {
|
|
626
|
+
baseOptions = configuration.baseOptions;
|
|
627
|
+
}
|
|
628
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
629
|
+
const localVarHeaderParameter = {};
|
|
630
|
+
const localVarQueryParameter = {};
|
|
631
|
+
if (xAmznShippingBusinessId != null) {
|
|
632
|
+
localVarHeaderParameter['x-amzn-shipping-business-id'] = String(xAmznShippingBusinessId);
|
|
633
|
+
}
|
|
634
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
635
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
636
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
637
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
638
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
639
|
+
return {
|
|
640
|
+
url: toPathString(localVarUrlObj),
|
|
641
|
+
options: localVarRequestOptions,
|
|
642
|
+
};
|
|
643
|
+
},
|
|
644
|
+
};
|
|
645
|
+
};
|
|
646
|
+
/**
|
|
647
|
+
* ShippingApi - functional programming interface
|
|
648
|
+
* @export
|
|
649
|
+
*/
|
|
650
|
+
export const ShippingApiFp = function (configuration) {
|
|
651
|
+
const localVarAxiosParamCreator = ShippingApiAxiosParamCreator(configuration);
|
|
652
|
+
return {
|
|
653
|
+
/**
|
|
654
|
+
* Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
655
|
+
* @param {string} shipmentId The shipment identifier originally returned by the purchaseShipment operation.
|
|
656
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
657
|
+
* @param {*} [options] Override http request option.
|
|
658
|
+
* @throws {RequiredError}
|
|
659
|
+
*/
|
|
660
|
+
async cancelShipment(shipmentId, xAmznShippingBusinessId, options) {
|
|
661
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelShipment(shipmentId, xAmznShippingBusinessId, options);
|
|
662
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
663
|
+
},
|
|
664
|
+
/**
|
|
665
|
+
* Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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 {DirectPurchaseRequest} body
|
|
667
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
668
|
+
* @param {string} [locale] The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags.
|
|
669
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
670
|
+
* @param {*} [options] Override http request option.
|
|
671
|
+
* @throws {RequiredError}
|
|
672
|
+
*/
|
|
673
|
+
async directPurchaseShipment(body, xAmznIdempotencyKey, locale, xAmznShippingBusinessId, options) {
|
|
674
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.directPurchaseShipment(body, xAmznIdempotencyKey, locale, xAmznShippingBusinessId, options);
|
|
675
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
676
|
+
},
|
|
677
|
+
/**
|
|
678
|
+
* This API Call to generate the collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
679
|
+
* @param {GenerateCollectionFormRequest} body
|
|
680
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
681
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
682
|
+
* @param {*} [options] Override http request option.
|
|
683
|
+
* @throws {RequiredError}
|
|
684
|
+
*/
|
|
685
|
+
async generateCollectionForm(body, xAmznIdempotencyKey, xAmznShippingBusinessId, options) {
|
|
686
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.generateCollectionForm(body, xAmznIdempotencyKey, xAmznShippingBusinessId, options);
|
|
687
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
688
|
+
},
|
|
689
|
+
/**
|
|
690
|
+
* Returns a list of access points in proximity of input postal code. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
691
|
+
* @param {Array<'HELIX' | 'CAMPUS_LOCKER' | 'OMNI_LOCKER' | 'ODIN_LOCKER' | 'DOBBY_LOCKER' | 'CORE_LOCKER' | '3P' | 'CAMPUS_ROOM'>} accessPointTypes
|
|
692
|
+
* @param {string} countryCode
|
|
693
|
+
* @param {string} postalCode
|
|
694
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
695
|
+
* @param {*} [options] Override http request option.
|
|
696
|
+
* @throws {RequiredError}
|
|
697
|
+
*/
|
|
698
|
+
async getAccessPoints(accessPointTypes, countryCode, postalCode, xAmznShippingBusinessId, options) {
|
|
699
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessPoints(accessPointTypes, countryCode, postalCode, xAmznShippingBusinessId, options);
|
|
700
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
701
|
+
},
|
|
702
|
+
/**
|
|
703
|
+
* Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
704
|
+
* @param {string} requestToken The request token returned in the response to the getRates operation.
|
|
705
|
+
* @param {string} rateId The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.
|
|
706
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
707
|
+
* @param {*} [options] Override http request option.
|
|
708
|
+
* @throws {RequiredError}
|
|
709
|
+
*/
|
|
710
|
+
async getAdditionalInputs(requestToken, rateId, xAmznShippingBusinessId, options) {
|
|
711
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAdditionalInputs(requestToken, rateId, xAmznShippingBusinessId, options);
|
|
712
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
713
|
+
},
|
|
714
|
+
/**
|
|
715
|
+
* This API will return a list of input schema required to register a shipper account with the carrier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
716
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
717
|
+
* @param {*} [options] Override http request option.
|
|
718
|
+
* @throws {RequiredError}
|
|
719
|
+
*/
|
|
720
|
+
async getCarrierAccountFormInputs(xAmznShippingBusinessId, options) {
|
|
721
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCarrierAccountFormInputs(xAmznShippingBusinessId, options);
|
|
722
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
723
|
+
},
|
|
724
|
+
/**
|
|
725
|
+
* This API will return Get all carrier accounts for a merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
726
|
+
* @param {GetCarrierAccountsRequest} body
|
|
727
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
728
|
+
* @param {*} [options] Override http request option.
|
|
729
|
+
* @throws {RequiredError}
|
|
730
|
+
*/
|
|
731
|
+
async getCarrierAccounts(body, xAmznShippingBusinessId, options) {
|
|
732
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCarrierAccounts(body, xAmznShippingBusinessId, options);
|
|
733
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
734
|
+
},
|
|
735
|
+
/**
|
|
736
|
+
* This API reprint a collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
737
|
+
* @param {string} collectionFormId collection form Id to reprint a collection.
|
|
738
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
739
|
+
* @param {*} [options] Override http request option.
|
|
740
|
+
* @throws {RequiredError}
|
|
741
|
+
*/
|
|
742
|
+
async getCollectionForm(collectionFormId, xAmznShippingBusinessId, options) {
|
|
743
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCollectionForm(collectionFormId, xAmznShippingBusinessId, options);
|
|
744
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
745
|
+
},
|
|
746
|
+
/**
|
|
747
|
+
* This API Call to get the history of the previously generated collection forms. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
748
|
+
* @param {GetCollectionFormHistoryRequest} body
|
|
749
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
750
|
+
* @param {*} [options] Override http request option.
|
|
751
|
+
* @throws {RequiredError}
|
|
752
|
+
*/
|
|
753
|
+
async getCollectionFormHistory(body, xAmznShippingBusinessId, options) {
|
|
754
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCollectionFormHistory(body, xAmznShippingBusinessId, options);
|
|
755
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
756
|
+
},
|
|
757
|
+
/**
|
|
758
|
+
* Returns the available shipping service offerings. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
759
|
+
* @param {GetRatesRequest} body
|
|
760
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
761
|
+
* @param {*} [options] Override http request option.
|
|
762
|
+
* @throws {RequiredError}
|
|
763
|
+
*/
|
|
764
|
+
async getRates(body, xAmznShippingBusinessId, options) {
|
|
765
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRates(body, xAmznShippingBusinessId, options);
|
|
766
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
767
|
+
},
|
|
768
|
+
/**
|
|
769
|
+
* Returns the shipping documents associated with a package in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
770
|
+
* @param {string} shipmentId The shipment identifier originally returned by the purchaseShipment operation.
|
|
771
|
+
* @param {string} packageClientReferenceId The package client reference identifier originally provided in the request body parameter for the getRates operation.
|
|
772
|
+
* @param {string} [format] The file format of the document. Must be one of the supported formats returned by the getRates operation.
|
|
773
|
+
* @param {number} [dpi] The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.
|
|
774
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
775
|
+
* @param {*} [options] Override http request option.
|
|
776
|
+
* @throws {RequiredError}
|
|
777
|
+
*/
|
|
778
|
+
async getShipmentDocuments(shipmentId, packageClientReferenceId, format, dpi, xAmznShippingBusinessId, options) {
|
|
779
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentDocuments(shipmentId, packageClientReferenceId, format, dpi, xAmznShippingBusinessId, options);
|
|
780
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
781
|
+
},
|
|
782
|
+
/**
|
|
783
|
+
* Returns tracking information for a purchased shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
784
|
+
* @param {string} trackingId A carrier-generated tracking identifier originally returned by the purchaseShipment operation.
|
|
785
|
+
* @param {string} carrierId A carrier identifier originally returned by the getRates operation for the selected rate.
|
|
786
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
787
|
+
* @param {*} [options] Override http request option.
|
|
788
|
+
* @throws {RequiredError}
|
|
789
|
+
*/
|
|
790
|
+
async getTracking(trackingId, carrierId, xAmznShippingBusinessId, options) {
|
|
791
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTracking(trackingId, carrierId, xAmznShippingBusinessId, options);
|
|
792
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
793
|
+
},
|
|
794
|
+
/**
|
|
795
|
+
* This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
796
|
+
* @param {GetUnmanifestedShipmentsRequest} body
|
|
797
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
798
|
+
* @param {*} [options] Override http request option.
|
|
799
|
+
* @throws {RequiredError}
|
|
800
|
+
*/
|
|
801
|
+
async getUnmanifestedShipments(body, xAmznShippingBusinessId, options) {
|
|
802
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getUnmanifestedShipments(body, xAmznShippingBusinessId, options);
|
|
803
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
804
|
+
},
|
|
805
|
+
/**
|
|
806
|
+
* This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
807
|
+
* @param {string} carrierId The unique identifier associated with the carrier account.
|
|
808
|
+
* @param {LinkCarrierAccountRequest} body
|
|
809
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
810
|
+
* @param {*} [options] Override http request option.
|
|
811
|
+
* @throws {RequiredError}
|
|
812
|
+
*/
|
|
813
|
+
async linkCarrierAccount(carrierId, body, xAmznShippingBusinessId, options) {
|
|
814
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.linkCarrierAccount(carrierId, body, xAmznShippingBusinessId, options);
|
|
815
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
816
|
+
},
|
|
817
|
+
/**
|
|
818
|
+
* Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
819
|
+
* @param {OneClickShipmentRequest} body
|
|
820
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
821
|
+
* @param {*} [options] Override http request option.
|
|
822
|
+
* @throws {RequiredError}
|
|
823
|
+
*/
|
|
824
|
+
async oneClickShipment(body, xAmznShippingBusinessId, options) {
|
|
825
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.oneClickShipment(body, xAmznShippingBusinessId, options);
|
|
826
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
827
|
+
},
|
|
828
|
+
/**
|
|
829
|
+
* Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
830
|
+
* @param {PurchaseShipmentRequest} body
|
|
831
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
832
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
833
|
+
* @param {*} [options] Override http request option.
|
|
834
|
+
* @throws {RequiredError}
|
|
835
|
+
*/
|
|
836
|
+
async purchaseShipment(body, xAmznIdempotencyKey, xAmznShippingBusinessId, options) {
|
|
837
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.purchaseShipment(body, xAmznIdempotencyKey, xAmznShippingBusinessId, options);
|
|
838
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
839
|
+
},
|
|
840
|
+
/**
|
|
841
|
+
* This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
842
|
+
* @param {string} carrierId carrier Id to unlink with merchant.
|
|
843
|
+
* @param {UnlinkCarrierAccountRequest} body
|
|
844
|
+
* @param {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
845
|
+
* @param {*} [options] Override http request option.
|
|
846
|
+
* @throws {RequiredError}
|
|
847
|
+
*/
|
|
848
|
+
async unlinkCarrierAccount(carrierId, body, xAmznShippingBusinessId, options) {
|
|
849
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.unlinkCarrierAccount(carrierId, body, xAmznShippingBusinessId, options);
|
|
850
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
851
|
+
},
|
|
852
|
+
};
|
|
853
|
+
};
|
|
854
|
+
/**
|
|
855
|
+
* ShippingApi - factory interface
|
|
856
|
+
* @export
|
|
857
|
+
*/
|
|
858
|
+
export const ShippingApiFactory = function (configuration, basePath, axios) {
|
|
859
|
+
const localVarFp = ShippingApiFp(configuration);
|
|
860
|
+
return {
|
|
861
|
+
/**
|
|
862
|
+
* Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
863
|
+
* @param {ShippingApiCancelShipmentRequest} requestParameters Request parameters.
|
|
864
|
+
* @param {*} [options] Override http request option.
|
|
865
|
+
* @throws {RequiredError}
|
|
866
|
+
*/
|
|
867
|
+
cancelShipment(requestParameters, options) {
|
|
868
|
+
return localVarFp.cancelShipment(requestParameters.shipmentId, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
869
|
+
},
|
|
870
|
+
/**
|
|
871
|
+
* Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
872
|
+
* @param {ShippingApiDirectPurchaseShipmentRequest} requestParameters Request parameters.
|
|
873
|
+
* @param {*} [options] Override http request option.
|
|
874
|
+
* @throws {RequiredError}
|
|
875
|
+
*/
|
|
876
|
+
directPurchaseShipment(requestParameters, options) {
|
|
877
|
+
return localVarFp.directPurchaseShipment(requestParameters.body, requestParameters.xAmznIdempotencyKey, requestParameters.locale, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
878
|
+
},
|
|
879
|
+
/**
|
|
880
|
+
* This API Call to generate the collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
881
|
+
* @param {ShippingApiGenerateCollectionFormRequest} requestParameters Request parameters.
|
|
882
|
+
* @param {*} [options] Override http request option.
|
|
883
|
+
* @throws {RequiredError}
|
|
884
|
+
*/
|
|
885
|
+
generateCollectionForm(requestParameters, options) {
|
|
886
|
+
return localVarFp.generateCollectionForm(requestParameters.body, requestParameters.xAmznIdempotencyKey, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
887
|
+
},
|
|
888
|
+
/**
|
|
889
|
+
* Returns a list of access points in proximity of input postal code. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
890
|
+
* @param {ShippingApiGetAccessPointsRequest} requestParameters Request parameters.
|
|
891
|
+
* @param {*} [options] Override http request option.
|
|
892
|
+
* @throws {RequiredError}
|
|
893
|
+
*/
|
|
894
|
+
getAccessPoints(requestParameters, options) {
|
|
895
|
+
return localVarFp.getAccessPoints(requestParameters.accessPointTypes, requestParameters.countryCode, requestParameters.postalCode, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
896
|
+
},
|
|
897
|
+
/**
|
|
898
|
+
* Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
899
|
+
* @param {ShippingApiGetAdditionalInputsRequest} requestParameters Request parameters.
|
|
900
|
+
* @param {*} [options] Override http request option.
|
|
901
|
+
* @throws {RequiredError}
|
|
902
|
+
*/
|
|
903
|
+
getAdditionalInputs(requestParameters, options) {
|
|
904
|
+
return localVarFp.getAdditionalInputs(requestParameters.requestToken, requestParameters.rateId, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
905
|
+
},
|
|
906
|
+
/**
|
|
907
|
+
* This API will return a list of input schema required to register a shipper account with the carrier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
908
|
+
* @param {ShippingApiGetCarrierAccountFormInputsRequest} requestParameters Request parameters.
|
|
909
|
+
* @param {*} [options] Override http request option.
|
|
910
|
+
* @throws {RequiredError}
|
|
911
|
+
*/
|
|
912
|
+
getCarrierAccountFormInputs(requestParameters = {}, options) {
|
|
913
|
+
return localVarFp.getCarrierAccountFormInputs(requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
914
|
+
},
|
|
915
|
+
/**
|
|
916
|
+
* This API will return Get all carrier accounts for a merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
917
|
+
* @param {ShippingApiGetCarrierAccountsRequest} requestParameters Request parameters.
|
|
918
|
+
* @param {*} [options] Override http request option.
|
|
919
|
+
* @throws {RequiredError}
|
|
920
|
+
*/
|
|
921
|
+
getCarrierAccounts(requestParameters, options) {
|
|
922
|
+
return localVarFp.getCarrierAccounts(requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
923
|
+
},
|
|
924
|
+
/**
|
|
925
|
+
* This API reprint a collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
926
|
+
* @param {ShippingApiGetCollectionFormRequest} requestParameters Request parameters.
|
|
927
|
+
* @param {*} [options] Override http request option.
|
|
928
|
+
* @throws {RequiredError}
|
|
929
|
+
*/
|
|
930
|
+
getCollectionForm(requestParameters, options) {
|
|
931
|
+
return localVarFp.getCollectionForm(requestParameters.collectionFormId, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
932
|
+
},
|
|
933
|
+
/**
|
|
934
|
+
* This API Call to get the history of the previously generated collection forms. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
935
|
+
* @param {ShippingApiGetCollectionFormHistoryRequest} requestParameters Request parameters.
|
|
936
|
+
* @param {*} [options] Override http request option.
|
|
937
|
+
* @throws {RequiredError}
|
|
938
|
+
*/
|
|
939
|
+
getCollectionFormHistory(requestParameters, options) {
|
|
940
|
+
return localVarFp.getCollectionFormHistory(requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
941
|
+
},
|
|
942
|
+
/**
|
|
943
|
+
* Returns the available shipping service offerings. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
944
|
+
* @param {ShippingApiGetRatesRequest} requestParameters Request parameters.
|
|
945
|
+
* @param {*} [options] Override http request option.
|
|
946
|
+
* @throws {RequiredError}
|
|
947
|
+
*/
|
|
948
|
+
getRates(requestParameters, options) {
|
|
949
|
+
return localVarFp.getRates(requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
950
|
+
},
|
|
951
|
+
/**
|
|
952
|
+
* Returns the shipping documents associated with a package in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
953
|
+
* @param {ShippingApiGetShipmentDocumentsRequest} requestParameters Request parameters.
|
|
954
|
+
* @param {*} [options] Override http request option.
|
|
955
|
+
* @throws {RequiredError}
|
|
956
|
+
*/
|
|
957
|
+
getShipmentDocuments(requestParameters, options) {
|
|
958
|
+
return localVarFp.getShipmentDocuments(requestParameters.shipmentId, requestParameters.packageClientReferenceId, requestParameters.format, requestParameters.dpi, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
959
|
+
},
|
|
960
|
+
/**
|
|
961
|
+
* Returns tracking information for a purchased shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
962
|
+
* @param {ShippingApiGetTrackingRequest} requestParameters Request parameters.
|
|
963
|
+
* @param {*} [options] Override http request option.
|
|
964
|
+
* @throws {RequiredError}
|
|
965
|
+
*/
|
|
966
|
+
getTracking(requestParameters, options) {
|
|
967
|
+
return localVarFp.getTracking(requestParameters.trackingId, requestParameters.carrierId, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
968
|
+
},
|
|
969
|
+
/**
|
|
970
|
+
* This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
971
|
+
* @param {ShippingApiGetUnmanifestedShipmentsRequest} requestParameters Request parameters.
|
|
972
|
+
* @param {*} [options] Override http request option.
|
|
973
|
+
* @throws {RequiredError}
|
|
974
|
+
*/
|
|
975
|
+
getUnmanifestedShipments(requestParameters, options) {
|
|
976
|
+
return localVarFp.getUnmanifestedShipments(requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
977
|
+
},
|
|
978
|
+
/**
|
|
979
|
+
* This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
980
|
+
* @param {ShippingApiLinkCarrierAccountRequest} requestParameters Request parameters.
|
|
981
|
+
* @param {*} [options] Override http request option.
|
|
982
|
+
* @throws {RequiredError}
|
|
983
|
+
*/
|
|
984
|
+
linkCarrierAccount(requestParameters, options) {
|
|
985
|
+
return localVarFp.linkCarrierAccount(requestParameters.carrierId, requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
986
|
+
},
|
|
987
|
+
/**
|
|
988
|
+
* Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
989
|
+
* @param {ShippingApiOneClickShipmentRequest} requestParameters Request parameters.
|
|
990
|
+
* @param {*} [options] Override http request option.
|
|
991
|
+
* @throws {RequiredError}
|
|
992
|
+
*/
|
|
993
|
+
oneClickShipment(requestParameters, options) {
|
|
994
|
+
return localVarFp.oneClickShipment(requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
995
|
+
},
|
|
996
|
+
/**
|
|
997
|
+
* Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
998
|
+
* @param {ShippingApiPurchaseShipmentRequest} requestParameters Request parameters.
|
|
999
|
+
* @param {*} [options] Override http request option.
|
|
1000
|
+
* @throws {RequiredError}
|
|
1001
|
+
*/
|
|
1002
|
+
purchaseShipment(requestParameters, options) {
|
|
1003
|
+
return localVarFp.purchaseShipment(requestParameters.body, requestParameters.xAmznIdempotencyKey, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
1004
|
+
},
|
|
1005
|
+
/**
|
|
1006
|
+
* This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1007
|
+
* @param {ShippingApiUnlinkCarrierAccountRequest} requestParameters Request parameters.
|
|
1008
|
+
* @param {*} [options] Override http request option.
|
|
1009
|
+
* @throws {RequiredError}
|
|
1010
|
+
*/
|
|
1011
|
+
unlinkCarrierAccount(requestParameters, options) {
|
|
1012
|
+
return localVarFp.unlinkCarrierAccount(requestParameters.carrierId, requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(axios, basePath));
|
|
1013
|
+
},
|
|
1014
|
+
};
|
|
1015
|
+
};
|
|
1016
|
+
/**
|
|
1017
|
+
* ShippingApi - object-oriented interface
|
|
1018
|
+
* @export
|
|
1019
|
+
* @class ShippingApi
|
|
1020
|
+
* @extends {BaseAPI}
|
|
1021
|
+
*/
|
|
1022
|
+
export class ShippingApi extends BaseAPI {
|
|
1023
|
+
/**
|
|
1024
|
+
* Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1025
|
+
* @param {ShippingApiCancelShipmentRequest} requestParameters Request parameters.
|
|
1026
|
+
* @param {*} [options] Override http request option.
|
|
1027
|
+
* @throws {RequiredError}
|
|
1028
|
+
* @memberof ShippingApi
|
|
1029
|
+
*/
|
|
1030
|
+
cancelShipment(requestParameters, options) {
|
|
1031
|
+
return ShippingApiFp(this.configuration).cancelShipment(requestParameters.shipmentId, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1032
|
+
}
|
|
1033
|
+
/**
|
|
1034
|
+
* Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1035
|
+
* @param {ShippingApiDirectPurchaseShipmentRequest} requestParameters Request parameters.
|
|
1036
|
+
* @param {*} [options] Override http request option.
|
|
1037
|
+
* @throws {RequiredError}
|
|
1038
|
+
* @memberof ShippingApi
|
|
1039
|
+
*/
|
|
1040
|
+
directPurchaseShipment(requestParameters, options) {
|
|
1041
|
+
return ShippingApiFp(this.configuration).directPurchaseShipment(requestParameters.body, requestParameters.xAmznIdempotencyKey, requestParameters.locale, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1042
|
+
}
|
|
1043
|
+
/**
|
|
1044
|
+
* This API Call to generate the collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1045
|
+
* @param {ShippingApiGenerateCollectionFormRequest} requestParameters Request parameters.
|
|
1046
|
+
* @param {*} [options] Override http request option.
|
|
1047
|
+
* @throws {RequiredError}
|
|
1048
|
+
* @memberof ShippingApi
|
|
1049
|
+
*/
|
|
1050
|
+
generateCollectionForm(requestParameters, options) {
|
|
1051
|
+
return ShippingApiFp(this.configuration).generateCollectionForm(requestParameters.body, requestParameters.xAmznIdempotencyKey, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1052
|
+
}
|
|
1053
|
+
/**
|
|
1054
|
+
* Returns a list of access points in proximity of input postal code. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1055
|
+
* @param {ShippingApiGetAccessPointsRequest} requestParameters Request parameters.
|
|
1056
|
+
* @param {*} [options] Override http request option.
|
|
1057
|
+
* @throws {RequiredError}
|
|
1058
|
+
* @memberof ShippingApi
|
|
1059
|
+
*/
|
|
1060
|
+
getAccessPoints(requestParameters, options) {
|
|
1061
|
+
return ShippingApiFp(this.configuration).getAccessPoints(requestParameters.accessPointTypes, requestParameters.countryCode, requestParameters.postalCode, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1062
|
+
}
|
|
1063
|
+
/**
|
|
1064
|
+
* Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1065
|
+
* @param {ShippingApiGetAdditionalInputsRequest} requestParameters Request parameters.
|
|
1066
|
+
* @param {*} [options] Override http request option.
|
|
1067
|
+
* @throws {RequiredError}
|
|
1068
|
+
* @memberof ShippingApi
|
|
1069
|
+
*/
|
|
1070
|
+
getAdditionalInputs(requestParameters, options) {
|
|
1071
|
+
return ShippingApiFp(this.configuration).getAdditionalInputs(requestParameters.requestToken, requestParameters.rateId, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1072
|
+
}
|
|
1073
|
+
/**
|
|
1074
|
+
* This API will return a list of input schema required to register a shipper account with the carrier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1075
|
+
* @param {ShippingApiGetCarrierAccountFormInputsRequest} requestParameters Request parameters.
|
|
1076
|
+
* @param {*} [options] Override http request option.
|
|
1077
|
+
* @throws {RequiredError}
|
|
1078
|
+
* @memberof ShippingApi
|
|
1079
|
+
*/
|
|
1080
|
+
getCarrierAccountFormInputs(requestParameters = {}, options) {
|
|
1081
|
+
return ShippingApiFp(this.configuration).getCarrierAccountFormInputs(requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1082
|
+
}
|
|
1083
|
+
/**
|
|
1084
|
+
* This API will return Get all carrier accounts for a merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1085
|
+
* @param {ShippingApiGetCarrierAccountsRequest} requestParameters Request parameters.
|
|
1086
|
+
* @param {*} [options] Override http request option.
|
|
1087
|
+
* @throws {RequiredError}
|
|
1088
|
+
* @memberof ShippingApi
|
|
1089
|
+
*/
|
|
1090
|
+
getCarrierAccounts(requestParameters, options) {
|
|
1091
|
+
return ShippingApiFp(this.configuration).getCarrierAccounts(requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1092
|
+
}
|
|
1093
|
+
/**
|
|
1094
|
+
* This API reprint a collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1095
|
+
* @param {ShippingApiGetCollectionFormRequest} requestParameters Request parameters.
|
|
1096
|
+
* @param {*} [options] Override http request option.
|
|
1097
|
+
* @throws {RequiredError}
|
|
1098
|
+
* @memberof ShippingApi
|
|
1099
|
+
*/
|
|
1100
|
+
getCollectionForm(requestParameters, options) {
|
|
1101
|
+
return ShippingApiFp(this.configuration).getCollectionForm(requestParameters.collectionFormId, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1102
|
+
}
|
|
1103
|
+
/**
|
|
1104
|
+
* This API Call to get the history of the previously generated collection forms. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1105
|
+
* @param {ShippingApiGetCollectionFormHistoryRequest} requestParameters Request parameters.
|
|
1106
|
+
* @param {*} [options] Override http request option.
|
|
1107
|
+
* @throws {RequiredError}
|
|
1108
|
+
* @memberof ShippingApi
|
|
1109
|
+
*/
|
|
1110
|
+
getCollectionFormHistory(requestParameters, options) {
|
|
1111
|
+
return ShippingApiFp(this.configuration).getCollectionFormHistory(requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1112
|
+
}
|
|
1113
|
+
/**
|
|
1114
|
+
* Returns the available shipping service offerings. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1115
|
+
* @param {ShippingApiGetRatesRequest} requestParameters Request parameters.
|
|
1116
|
+
* @param {*} [options] Override http request option.
|
|
1117
|
+
* @throws {RequiredError}
|
|
1118
|
+
* @memberof ShippingApi
|
|
1119
|
+
*/
|
|
1120
|
+
getRates(requestParameters, options) {
|
|
1121
|
+
return ShippingApiFp(this.configuration).getRates(requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1122
|
+
}
|
|
1123
|
+
/**
|
|
1124
|
+
* Returns the shipping documents associated with a package in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1125
|
+
* @param {ShippingApiGetShipmentDocumentsRequest} requestParameters Request parameters.
|
|
1126
|
+
* @param {*} [options] Override http request option.
|
|
1127
|
+
* @throws {RequiredError}
|
|
1128
|
+
* @memberof ShippingApi
|
|
1129
|
+
*/
|
|
1130
|
+
getShipmentDocuments(requestParameters, options) {
|
|
1131
|
+
return ShippingApiFp(this.configuration).getShipmentDocuments(requestParameters.shipmentId, requestParameters.packageClientReferenceId, requestParameters.format, requestParameters.dpi, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1132
|
+
}
|
|
1133
|
+
/**
|
|
1134
|
+
* Returns tracking information for a purchased shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1135
|
+
* @param {ShippingApiGetTrackingRequest} requestParameters Request parameters.
|
|
1136
|
+
* @param {*} [options] Override http request option.
|
|
1137
|
+
* @throws {RequiredError}
|
|
1138
|
+
* @memberof ShippingApi
|
|
1139
|
+
*/
|
|
1140
|
+
getTracking(requestParameters, options) {
|
|
1141
|
+
return ShippingApiFp(this.configuration).getTracking(requestParameters.trackingId, requestParameters.carrierId, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1142
|
+
}
|
|
1143
|
+
/**
|
|
1144
|
+
* This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1145
|
+
* @param {ShippingApiGetUnmanifestedShipmentsRequest} requestParameters Request parameters.
|
|
1146
|
+
* @param {*} [options] Override http request option.
|
|
1147
|
+
* @throws {RequiredError}
|
|
1148
|
+
* @memberof ShippingApi
|
|
1149
|
+
*/
|
|
1150
|
+
getUnmanifestedShipments(requestParameters, options) {
|
|
1151
|
+
return ShippingApiFp(this.configuration).getUnmanifestedShipments(requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1152
|
+
}
|
|
1153
|
+
/**
|
|
1154
|
+
* This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1155
|
+
* @param {ShippingApiLinkCarrierAccountRequest} requestParameters Request parameters.
|
|
1156
|
+
* @param {*} [options] Override http request option.
|
|
1157
|
+
* @throws {RequiredError}
|
|
1158
|
+
* @memberof ShippingApi
|
|
1159
|
+
*/
|
|
1160
|
+
linkCarrierAccount(requestParameters, options) {
|
|
1161
|
+
return ShippingApiFp(this.configuration).linkCarrierAccount(requestParameters.carrierId, requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1162
|
+
}
|
|
1163
|
+
/**
|
|
1164
|
+
* Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [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).
|
|
1165
|
+
* @param {ShippingApiOneClickShipmentRequest} requestParameters Request parameters.
|
|
1166
|
+
* @param {*} [options] Override http request option.
|
|
1167
|
+
* @throws {RequiredError}
|
|
1168
|
+
* @memberof ShippingApi
|
|
1169
|
+
*/
|
|
1170
|
+
oneClickShipment(requestParameters, options) {
|
|
1171
|
+
return ShippingApiFp(this.configuration).oneClickShipment(requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1172
|
+
}
|
|
1173
|
+
/**
|
|
1174
|
+
* Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1175
|
+
* @param {ShippingApiPurchaseShipmentRequest} requestParameters Request parameters.
|
|
1176
|
+
* @param {*} [options] Override http request option.
|
|
1177
|
+
* @throws {RequiredError}
|
|
1178
|
+
* @memberof ShippingApi
|
|
1179
|
+
*/
|
|
1180
|
+
purchaseShipment(requestParameters, options) {
|
|
1181
|
+
return ShippingApiFp(this.configuration).purchaseShipment(requestParameters.body, requestParameters.xAmznIdempotencyKey, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1182
|
+
}
|
|
1183
|
+
/**
|
|
1184
|
+
* This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1185
|
+
* @param {ShippingApiUnlinkCarrierAccountRequest} requestParameters Request parameters.
|
|
1186
|
+
* @param {*} [options] Override http request option.
|
|
1187
|
+
* @throws {RequiredError}
|
|
1188
|
+
* @memberof ShippingApi
|
|
1189
|
+
*/
|
|
1190
|
+
unlinkCarrierAccount(requestParameters, options) {
|
|
1191
|
+
return ShippingApiFp(this.configuration).unlinkCarrierAccount(requestParameters.carrierId, requestParameters.body, requestParameters.xAmznShippingBusinessId, options).then((request) => request(this.axios, this.basePath));
|
|
1192
|
+
}
|
|
1193
|
+
}
|