@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,1014 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Amazon Shipping API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v2
|
|
6
|
+
* Contact: swa-api-core@amazon.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
16
|
+
import { CancelShipmentResponse } from '../models';
|
|
17
|
+
import { DirectPurchaseRequest } from '../models';
|
|
18
|
+
import { DirectPurchaseResponse } from '../models';
|
|
19
|
+
import { GenerateCollectionFormRequest } from '../models';
|
|
20
|
+
import { GenerateCollectionFormResponse } from '../models';
|
|
21
|
+
import { GetAccessPointsResponse } from '../models';
|
|
22
|
+
import { GetAdditionalInputsResponse } from '../models';
|
|
23
|
+
import { GetCarrierAccountFormInputsResponse } from '../models';
|
|
24
|
+
import { GetCarrierAccountsRequest } from '../models';
|
|
25
|
+
import { GetCarrierAccountsResponse } from '../models';
|
|
26
|
+
import { GetCollectionFormHistoryRequest } from '../models';
|
|
27
|
+
import { GetCollectionFormHistoryResponse } from '../models';
|
|
28
|
+
import { GetCollectionFormResponse } from '../models';
|
|
29
|
+
import { GetRatesRequest } from '../models';
|
|
30
|
+
import { GetRatesResponse } from '../models';
|
|
31
|
+
import { GetShipmentDocumentsResponse } from '../models';
|
|
32
|
+
import { GetTrackingResponse } from '../models';
|
|
33
|
+
import { GetUnmanifestedShipmentsRequest } from '../models';
|
|
34
|
+
import { GetUnmanifestedShipmentsResponse } from '../models';
|
|
35
|
+
import { LinkCarrierAccountRequest } from '../models';
|
|
36
|
+
import { LinkCarrierAccountResponse } from '../models';
|
|
37
|
+
import { OneClickShipmentRequest } from '../models';
|
|
38
|
+
import { OneClickShipmentResponse } from '../models';
|
|
39
|
+
import { PurchaseShipmentRequest } from '../models';
|
|
40
|
+
import { PurchaseShipmentResponse } from '../models';
|
|
41
|
+
import { UnlinkCarrierAccountRequest } from '../models';
|
|
42
|
+
import { UnlinkCarrierAccountResponse } from '../models';
|
|
43
|
+
/**
|
|
44
|
+
* ShippingApi - axios parameter creator
|
|
45
|
+
* @export
|
|
46
|
+
*/
|
|
47
|
+
export declare const ShippingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
48
|
+
/**
|
|
49
|
+
* 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).
|
|
50
|
+
* @param {string} shipmentId The shipment identifier originally returned by the purchaseShipment operation.
|
|
51
|
+
* @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.
|
|
52
|
+
* @param {*} [options] Override http request option.
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
cancelShipment: (shipmentId: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
+
/**
|
|
57
|
+
* 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).
|
|
58
|
+
* @param {DirectPurchaseRequest} body
|
|
59
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
60
|
+
* @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.
|
|
61
|
+
* @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.
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
directPurchaseShipment: (body: DirectPurchaseRequest, xAmznIdempotencyKey?: string, locale?: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
/**
|
|
67
|
+
* 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).
|
|
68
|
+
* @param {GenerateCollectionFormRequest} body
|
|
69
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
70
|
+
* @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.
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
generateCollectionForm: (body: GenerateCollectionFormRequest, xAmznIdempotencyKey?: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
75
|
+
/**
|
|
76
|
+
* 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).
|
|
77
|
+
* @param {Array<'HELIX' | 'CAMPUS_LOCKER' | 'OMNI_LOCKER' | 'ODIN_LOCKER' | 'DOBBY_LOCKER' | 'CORE_LOCKER' | '3P' | 'CAMPUS_ROOM'>} accessPointTypes
|
|
78
|
+
* @param {string} countryCode
|
|
79
|
+
* @param {string} postalCode
|
|
80
|
+
* @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.
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
*/
|
|
84
|
+
getAccessPoints: (accessPointTypes: Array<'HELIX' | 'CAMPUS_LOCKER' | 'OMNI_LOCKER' | 'ODIN_LOCKER' | 'DOBBY_LOCKER' | 'CORE_LOCKER' | '3P' | 'CAMPUS_ROOM'>, countryCode: string, postalCode: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
|
+
/**
|
|
86
|
+
* 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).
|
|
87
|
+
* @param {string} requestToken The request token returned in the response to the getRates operation.
|
|
88
|
+
* @param {string} rateId The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.
|
|
89
|
+
* @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.
|
|
90
|
+
* @param {*} [options] Override http request option.
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
getAdditionalInputs: (requestToken: string, rateId: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
|
+
/**
|
|
95
|
+
* 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).
|
|
96
|
+
* @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.
|
|
97
|
+
* @param {*} [options] Override http request option.
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
*/
|
|
100
|
+
getCarrierAccountFormInputs: (xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
101
|
+
/**
|
|
102
|
+
* 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).
|
|
103
|
+
* @param {GetCarrierAccountsRequest} body
|
|
104
|
+
* @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.
|
|
105
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
*/
|
|
108
|
+
getCarrierAccounts: (body: GetCarrierAccountsRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
109
|
+
/**
|
|
110
|
+
* 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).
|
|
111
|
+
* @param {string} collectionFormId collection form Id to reprint a collection.
|
|
112
|
+
* @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.
|
|
113
|
+
* @param {*} [options] Override http request option.
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
*/
|
|
116
|
+
getCollectionForm: (collectionFormId: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
117
|
+
/**
|
|
118
|
+
* 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).
|
|
119
|
+
* @param {GetCollectionFormHistoryRequest} body
|
|
120
|
+
* @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.
|
|
121
|
+
* @param {*} [options] Override http request option.
|
|
122
|
+
* @throws {RequiredError}
|
|
123
|
+
*/
|
|
124
|
+
getCollectionFormHistory: (body: GetCollectionFormHistoryRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
125
|
+
/**
|
|
126
|
+
* 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).
|
|
127
|
+
* @param {GetRatesRequest} body
|
|
128
|
+
* @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.
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
*/
|
|
132
|
+
getRates: (body: GetRatesRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
133
|
+
/**
|
|
134
|
+
* 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).
|
|
135
|
+
* @param {string} shipmentId The shipment identifier originally returned by the purchaseShipment operation.
|
|
136
|
+
* @param {string} packageClientReferenceId The package client reference identifier originally provided in the request body parameter for the getRates operation.
|
|
137
|
+
* @param {string} [format] The file format of the document. Must be one of the supported formats returned by the getRates operation.
|
|
138
|
+
* @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.
|
|
139
|
+
* @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.
|
|
140
|
+
* @param {*} [options] Override http request option.
|
|
141
|
+
* @throws {RequiredError}
|
|
142
|
+
*/
|
|
143
|
+
getShipmentDocuments: (shipmentId: string, packageClientReferenceId: string, format?: string, dpi?: number, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
144
|
+
/**
|
|
145
|
+
* 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).
|
|
146
|
+
* @param {string} trackingId A carrier-generated tracking identifier originally returned by the purchaseShipment operation.
|
|
147
|
+
* @param {string} carrierId A carrier identifier originally returned by the getRates operation for the selected rate.
|
|
148
|
+
* @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.
|
|
149
|
+
* @param {*} [options] Override http request option.
|
|
150
|
+
* @throws {RequiredError}
|
|
151
|
+
*/
|
|
152
|
+
getTracking: (trackingId: string, carrierId: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
153
|
+
/**
|
|
154
|
+
* 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).
|
|
155
|
+
* @param {GetUnmanifestedShipmentsRequest} body
|
|
156
|
+
* @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.
|
|
157
|
+
* @param {*} [options] Override http request option.
|
|
158
|
+
* @throws {RequiredError}
|
|
159
|
+
*/
|
|
160
|
+
getUnmanifestedShipments: (body: GetUnmanifestedShipmentsRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
161
|
+
/**
|
|
162
|
+
* 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).
|
|
163
|
+
* @param {string} carrierId The unique identifier associated with the carrier account.
|
|
164
|
+
* @param {LinkCarrierAccountRequest} body
|
|
165
|
+
* @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.
|
|
166
|
+
* @param {*} [options] Override http request option.
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
*/
|
|
169
|
+
linkCarrierAccount: (carrierId: string, body: LinkCarrierAccountRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
170
|
+
/**
|
|
171
|
+
* 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).
|
|
172
|
+
* @param {OneClickShipmentRequest} body
|
|
173
|
+
* @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.
|
|
174
|
+
* @param {*} [options] Override http request option.
|
|
175
|
+
* @throws {RequiredError}
|
|
176
|
+
*/
|
|
177
|
+
oneClickShipment: (body: OneClickShipmentRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
178
|
+
/**
|
|
179
|
+
* 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).
|
|
180
|
+
* @param {PurchaseShipmentRequest} body
|
|
181
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
182
|
+
* @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.
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
purchaseShipment: (body: PurchaseShipmentRequest, xAmznIdempotencyKey?: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
187
|
+
/**
|
|
188
|
+
* 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).
|
|
189
|
+
* @param {string} carrierId carrier Id to unlink with merchant.
|
|
190
|
+
* @param {UnlinkCarrierAccountRequest} body
|
|
191
|
+
* @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.
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
unlinkCarrierAccount: (carrierId: string, body: UnlinkCarrierAccountRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
* ShippingApi - functional programming interface
|
|
199
|
+
* @export
|
|
200
|
+
*/
|
|
201
|
+
export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
202
|
+
/**
|
|
203
|
+
* 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).
|
|
204
|
+
* @param {string} shipmentId The shipment identifier originally returned by the purchaseShipment operation.
|
|
205
|
+
* @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.
|
|
206
|
+
* @param {*} [options] Override http request option.
|
|
207
|
+
* @throws {RequiredError}
|
|
208
|
+
*/
|
|
209
|
+
cancelShipment(shipmentId: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelShipmentResponse>>;
|
|
210
|
+
/**
|
|
211
|
+
* 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).
|
|
212
|
+
* @param {DirectPurchaseRequest} body
|
|
213
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
214
|
+
* @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.
|
|
215
|
+
* @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.
|
|
216
|
+
* @param {*} [options] Override http request option.
|
|
217
|
+
* @throws {RequiredError}
|
|
218
|
+
*/
|
|
219
|
+
directPurchaseShipment(body: DirectPurchaseRequest, xAmznIdempotencyKey?: string, locale?: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DirectPurchaseResponse>>;
|
|
220
|
+
/**
|
|
221
|
+
* 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).
|
|
222
|
+
* @param {GenerateCollectionFormRequest} body
|
|
223
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
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
|
+
generateCollectionForm(body: GenerateCollectionFormRequest, xAmznIdempotencyKey?: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionFormResponse>>;
|
|
229
|
+
/**
|
|
230
|
+
* 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).
|
|
231
|
+
* @param {Array<'HELIX' | 'CAMPUS_LOCKER' | 'OMNI_LOCKER' | 'ODIN_LOCKER' | 'DOBBY_LOCKER' | 'CORE_LOCKER' | '3P' | 'CAMPUS_ROOM'>} accessPointTypes
|
|
232
|
+
* @param {string} countryCode
|
|
233
|
+
* @param {string} postalCode
|
|
234
|
+
* @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.
|
|
235
|
+
* @param {*} [options] Override http request option.
|
|
236
|
+
* @throws {RequiredError}
|
|
237
|
+
*/
|
|
238
|
+
getAccessPoints(accessPointTypes: Array<'HELIX' | 'CAMPUS_LOCKER' | 'OMNI_LOCKER' | 'ODIN_LOCKER' | 'DOBBY_LOCKER' | 'CORE_LOCKER' | '3P' | 'CAMPUS_ROOM'>, countryCode: string, postalCode: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccessPointsResponse>>;
|
|
239
|
+
/**
|
|
240
|
+
* 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).
|
|
241
|
+
* @param {string} requestToken The request token returned in the response to the getRates operation.
|
|
242
|
+
* @param {string} rateId The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.
|
|
243
|
+
* @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.
|
|
244
|
+
* @param {*} [options] Override http request option.
|
|
245
|
+
* @throws {RequiredError}
|
|
246
|
+
*/
|
|
247
|
+
getAdditionalInputs(requestToken: string, rateId: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAdditionalInputsResponse>>;
|
|
248
|
+
/**
|
|
249
|
+
* 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).
|
|
250
|
+
* @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.
|
|
251
|
+
* @param {*} [options] Override http request option.
|
|
252
|
+
* @throws {RequiredError}
|
|
253
|
+
*/
|
|
254
|
+
getCarrierAccountFormInputs(xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCarrierAccountFormInputsResponse>>;
|
|
255
|
+
/**
|
|
256
|
+
* 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).
|
|
257
|
+
* @param {GetCarrierAccountsRequest} body
|
|
258
|
+
* @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.
|
|
259
|
+
* @param {*} [options] Override http request option.
|
|
260
|
+
* @throws {RequiredError}
|
|
261
|
+
*/
|
|
262
|
+
getCarrierAccounts(body: GetCarrierAccountsRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCarrierAccountsResponse>>;
|
|
263
|
+
/**
|
|
264
|
+
* 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).
|
|
265
|
+
* @param {string} collectionFormId collection form Id to reprint a collection.
|
|
266
|
+
* @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.
|
|
267
|
+
* @param {*} [options] Override http request option.
|
|
268
|
+
* @throws {RequiredError}
|
|
269
|
+
*/
|
|
270
|
+
getCollectionForm(collectionFormId: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCollectionFormResponse>>;
|
|
271
|
+
/**
|
|
272
|
+
* 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).
|
|
273
|
+
* @param {GetCollectionFormHistoryRequest} body
|
|
274
|
+
* @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.
|
|
275
|
+
* @param {*} [options] Override http request option.
|
|
276
|
+
* @throws {RequiredError}
|
|
277
|
+
*/
|
|
278
|
+
getCollectionFormHistory(body: GetCollectionFormHistoryRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCollectionFormHistoryResponse>>;
|
|
279
|
+
/**
|
|
280
|
+
* 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).
|
|
281
|
+
* @param {GetRatesRequest} body
|
|
282
|
+
* @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.
|
|
283
|
+
* @param {*} [options] Override http request option.
|
|
284
|
+
* @throws {RequiredError}
|
|
285
|
+
*/
|
|
286
|
+
getRates(body: GetRatesRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRatesResponse>>;
|
|
287
|
+
/**
|
|
288
|
+
* 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).
|
|
289
|
+
* @param {string} shipmentId The shipment identifier originally returned by the purchaseShipment operation.
|
|
290
|
+
* @param {string} packageClientReferenceId The package client reference identifier originally provided in the request body parameter for the getRates operation.
|
|
291
|
+
* @param {string} [format] The file format of the document. Must be one of the supported formats returned by the getRates operation.
|
|
292
|
+
* @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.
|
|
293
|
+
* @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.
|
|
294
|
+
* @param {*} [options] Override http request option.
|
|
295
|
+
* @throws {RequiredError}
|
|
296
|
+
*/
|
|
297
|
+
getShipmentDocuments(shipmentId: string, packageClientReferenceId: string, format?: string, dpi?: number, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentDocumentsResponse>>;
|
|
298
|
+
/**
|
|
299
|
+
* 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).
|
|
300
|
+
* @param {string} trackingId A carrier-generated tracking identifier originally returned by the purchaseShipment operation.
|
|
301
|
+
* @param {string} carrierId A carrier identifier originally returned by the getRates operation for the selected rate.
|
|
302
|
+
* @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.
|
|
303
|
+
* @param {*} [options] Override http request option.
|
|
304
|
+
* @throws {RequiredError}
|
|
305
|
+
*/
|
|
306
|
+
getTracking(trackingId: string, carrierId: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrackingResponse>>;
|
|
307
|
+
/**
|
|
308
|
+
* 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).
|
|
309
|
+
* @param {GetUnmanifestedShipmentsRequest} body
|
|
310
|
+
* @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.
|
|
311
|
+
* @param {*} [options] Override http request option.
|
|
312
|
+
* @throws {RequiredError}
|
|
313
|
+
*/
|
|
314
|
+
getUnmanifestedShipments(body: GetUnmanifestedShipmentsRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUnmanifestedShipmentsResponse>>;
|
|
315
|
+
/**
|
|
316
|
+
* 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).
|
|
317
|
+
* @param {string} carrierId The unique identifier associated with the carrier account.
|
|
318
|
+
* @param {LinkCarrierAccountRequest} body
|
|
319
|
+
* @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.
|
|
320
|
+
* @param {*} [options] Override http request option.
|
|
321
|
+
* @throws {RequiredError}
|
|
322
|
+
*/
|
|
323
|
+
linkCarrierAccount(carrierId: string, body: LinkCarrierAccountRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkCarrierAccountResponse>>;
|
|
324
|
+
/**
|
|
325
|
+
* 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).
|
|
326
|
+
* @param {OneClickShipmentRequest} body
|
|
327
|
+
* @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.
|
|
328
|
+
* @param {*} [options] Override http request option.
|
|
329
|
+
* @throws {RequiredError}
|
|
330
|
+
*/
|
|
331
|
+
oneClickShipment(body: OneClickShipmentRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OneClickShipmentResponse>>;
|
|
332
|
+
/**
|
|
333
|
+
* 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).
|
|
334
|
+
* @param {PurchaseShipmentRequest} body
|
|
335
|
+
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
336
|
+
* @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.
|
|
337
|
+
* @param {*} [options] Override http request option.
|
|
338
|
+
* @throws {RequiredError}
|
|
339
|
+
*/
|
|
340
|
+
purchaseShipment(body: PurchaseShipmentRequest, xAmznIdempotencyKey?: string, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurchaseShipmentResponse>>;
|
|
341
|
+
/**
|
|
342
|
+
* 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).
|
|
343
|
+
* @param {string} carrierId carrier Id to unlink with merchant.
|
|
344
|
+
* @param {UnlinkCarrierAccountRequest} body
|
|
345
|
+
* @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.
|
|
346
|
+
* @param {*} [options] Override http request option.
|
|
347
|
+
* @throws {RequiredError}
|
|
348
|
+
*/
|
|
349
|
+
unlinkCarrierAccount(carrierId: string, body: UnlinkCarrierAccountRequest, xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnlinkCarrierAccountResponse>>;
|
|
350
|
+
};
|
|
351
|
+
/**
|
|
352
|
+
* ShippingApi - factory interface
|
|
353
|
+
* @export
|
|
354
|
+
*/
|
|
355
|
+
export declare const ShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
356
|
+
/**
|
|
357
|
+
* 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).
|
|
358
|
+
* @param {ShippingApiCancelShipmentRequest} requestParameters Request parameters.
|
|
359
|
+
* @param {*} [options] Override http request option.
|
|
360
|
+
* @throws {RequiredError}
|
|
361
|
+
*/
|
|
362
|
+
cancelShipment(requestParameters: ShippingApiCancelShipmentRequest, options?: AxiosRequestConfig): AxiosPromise<CancelShipmentResponse>;
|
|
363
|
+
/**
|
|
364
|
+
* 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).
|
|
365
|
+
* @param {ShippingApiDirectPurchaseShipmentRequest} requestParameters Request parameters.
|
|
366
|
+
* @param {*} [options] Override http request option.
|
|
367
|
+
* @throws {RequiredError}
|
|
368
|
+
*/
|
|
369
|
+
directPurchaseShipment(requestParameters: ShippingApiDirectPurchaseShipmentRequest, options?: AxiosRequestConfig): AxiosPromise<DirectPurchaseResponse>;
|
|
370
|
+
/**
|
|
371
|
+
* 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).
|
|
372
|
+
* @param {ShippingApiGenerateCollectionFormRequest} requestParameters Request parameters.
|
|
373
|
+
* @param {*} [options] Override http request option.
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
*/
|
|
376
|
+
generateCollectionForm(requestParameters: ShippingApiGenerateCollectionFormRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateCollectionFormResponse>;
|
|
377
|
+
/**
|
|
378
|
+
* 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).
|
|
379
|
+
* @param {ShippingApiGetAccessPointsRequest} requestParameters Request parameters.
|
|
380
|
+
* @param {*} [options] Override http request option.
|
|
381
|
+
* @throws {RequiredError}
|
|
382
|
+
*/
|
|
383
|
+
getAccessPoints(requestParameters: ShippingApiGetAccessPointsRequest, options?: AxiosRequestConfig): AxiosPromise<GetAccessPointsResponse>;
|
|
384
|
+
/**
|
|
385
|
+
* 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).
|
|
386
|
+
* @param {ShippingApiGetAdditionalInputsRequest} requestParameters Request parameters.
|
|
387
|
+
* @param {*} [options] Override http request option.
|
|
388
|
+
* @throws {RequiredError}
|
|
389
|
+
*/
|
|
390
|
+
getAdditionalInputs(requestParameters: ShippingApiGetAdditionalInputsRequest, options?: AxiosRequestConfig): AxiosPromise<GetAdditionalInputsResponse>;
|
|
391
|
+
/**
|
|
392
|
+
* 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).
|
|
393
|
+
* @param {ShippingApiGetCarrierAccountFormInputsRequest} requestParameters Request parameters.
|
|
394
|
+
* @param {*} [options] Override http request option.
|
|
395
|
+
* @throws {RequiredError}
|
|
396
|
+
*/
|
|
397
|
+
getCarrierAccountFormInputs(requestParameters?: ShippingApiGetCarrierAccountFormInputsRequest, options?: AxiosRequestConfig): AxiosPromise<GetCarrierAccountFormInputsResponse>;
|
|
398
|
+
/**
|
|
399
|
+
* 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).
|
|
400
|
+
* @param {ShippingApiGetCarrierAccountsRequest} requestParameters Request parameters.
|
|
401
|
+
* @param {*} [options] Override http request option.
|
|
402
|
+
* @throws {RequiredError}
|
|
403
|
+
*/
|
|
404
|
+
getCarrierAccounts(requestParameters: ShippingApiGetCarrierAccountsRequest, options?: AxiosRequestConfig): AxiosPromise<GetCarrierAccountsResponse>;
|
|
405
|
+
/**
|
|
406
|
+
* 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).
|
|
407
|
+
* @param {ShippingApiGetCollectionFormRequest} requestParameters Request parameters.
|
|
408
|
+
* @param {*} [options] Override http request option.
|
|
409
|
+
* @throws {RequiredError}
|
|
410
|
+
*/
|
|
411
|
+
getCollectionForm(requestParameters: ShippingApiGetCollectionFormRequest, options?: AxiosRequestConfig): AxiosPromise<GetCollectionFormResponse>;
|
|
412
|
+
/**
|
|
413
|
+
* 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).
|
|
414
|
+
* @param {ShippingApiGetCollectionFormHistoryRequest} requestParameters Request parameters.
|
|
415
|
+
* @param {*} [options] Override http request option.
|
|
416
|
+
* @throws {RequiredError}
|
|
417
|
+
*/
|
|
418
|
+
getCollectionFormHistory(requestParameters: ShippingApiGetCollectionFormHistoryRequest, options?: AxiosRequestConfig): AxiosPromise<GetCollectionFormHistoryResponse>;
|
|
419
|
+
/**
|
|
420
|
+
* 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).
|
|
421
|
+
* @param {ShippingApiGetRatesRequest} requestParameters Request parameters.
|
|
422
|
+
* @param {*} [options] Override http request option.
|
|
423
|
+
* @throws {RequiredError}
|
|
424
|
+
*/
|
|
425
|
+
getRates(requestParameters: ShippingApiGetRatesRequest, options?: AxiosRequestConfig): AxiosPromise<GetRatesResponse>;
|
|
426
|
+
/**
|
|
427
|
+
* 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).
|
|
428
|
+
* @param {ShippingApiGetShipmentDocumentsRequest} requestParameters Request parameters.
|
|
429
|
+
* @param {*} [options] Override http request option.
|
|
430
|
+
* @throws {RequiredError}
|
|
431
|
+
*/
|
|
432
|
+
getShipmentDocuments(requestParameters: ShippingApiGetShipmentDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<GetShipmentDocumentsResponse>;
|
|
433
|
+
/**
|
|
434
|
+
* 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).
|
|
435
|
+
* @param {ShippingApiGetTrackingRequest} requestParameters Request parameters.
|
|
436
|
+
* @param {*} [options] Override http request option.
|
|
437
|
+
* @throws {RequiredError}
|
|
438
|
+
*/
|
|
439
|
+
getTracking(requestParameters: ShippingApiGetTrackingRequest, options?: AxiosRequestConfig): AxiosPromise<GetTrackingResponse>;
|
|
440
|
+
/**
|
|
441
|
+
* 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).
|
|
442
|
+
* @param {ShippingApiGetUnmanifestedShipmentsRequest} requestParameters Request parameters.
|
|
443
|
+
* @param {*} [options] Override http request option.
|
|
444
|
+
* @throws {RequiredError}
|
|
445
|
+
*/
|
|
446
|
+
getUnmanifestedShipments(requestParameters: ShippingApiGetUnmanifestedShipmentsRequest, options?: AxiosRequestConfig): AxiosPromise<GetUnmanifestedShipmentsResponse>;
|
|
447
|
+
/**
|
|
448
|
+
* 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).
|
|
449
|
+
* @param {ShippingApiLinkCarrierAccountRequest} requestParameters Request parameters.
|
|
450
|
+
* @param {*} [options] Override http request option.
|
|
451
|
+
* @throws {RequiredError}
|
|
452
|
+
*/
|
|
453
|
+
linkCarrierAccount(requestParameters: ShippingApiLinkCarrierAccountRequest, options?: AxiosRequestConfig): AxiosPromise<LinkCarrierAccountResponse>;
|
|
454
|
+
/**
|
|
455
|
+
* 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).
|
|
456
|
+
* @param {ShippingApiOneClickShipmentRequest} requestParameters Request parameters.
|
|
457
|
+
* @param {*} [options] Override http request option.
|
|
458
|
+
* @throws {RequiredError}
|
|
459
|
+
*/
|
|
460
|
+
oneClickShipment(requestParameters: ShippingApiOneClickShipmentRequest, options?: AxiosRequestConfig): AxiosPromise<OneClickShipmentResponse>;
|
|
461
|
+
/**
|
|
462
|
+
* 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).
|
|
463
|
+
* @param {ShippingApiPurchaseShipmentRequest} requestParameters Request parameters.
|
|
464
|
+
* @param {*} [options] Override http request option.
|
|
465
|
+
* @throws {RequiredError}
|
|
466
|
+
*/
|
|
467
|
+
purchaseShipment(requestParameters: ShippingApiPurchaseShipmentRequest, options?: AxiosRequestConfig): AxiosPromise<PurchaseShipmentResponse>;
|
|
468
|
+
/**
|
|
469
|
+
* 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).
|
|
470
|
+
* @param {ShippingApiUnlinkCarrierAccountRequest} requestParameters Request parameters.
|
|
471
|
+
* @param {*} [options] Override http request option.
|
|
472
|
+
* @throws {RequiredError}
|
|
473
|
+
*/
|
|
474
|
+
unlinkCarrierAccount(requestParameters: ShippingApiUnlinkCarrierAccountRequest, options?: AxiosRequestConfig): AxiosPromise<UnlinkCarrierAccountResponse>;
|
|
475
|
+
};
|
|
476
|
+
/**
|
|
477
|
+
* Request parameters for cancelShipment operation in ShippingApi.
|
|
478
|
+
* @export
|
|
479
|
+
* @interface ShippingApiCancelShipmentRequest
|
|
480
|
+
*/
|
|
481
|
+
export interface ShippingApiCancelShipmentRequest {
|
|
482
|
+
/**
|
|
483
|
+
* The shipment identifier originally returned by the purchaseShipment operation.
|
|
484
|
+
* @type {string}
|
|
485
|
+
* @memberof ShippingApiCancelShipment
|
|
486
|
+
*/
|
|
487
|
+
readonly shipmentId: string;
|
|
488
|
+
/**
|
|
489
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
490
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
491
|
+
* @memberof ShippingApiCancelShipment
|
|
492
|
+
*/
|
|
493
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
494
|
+
}
|
|
495
|
+
/**
|
|
496
|
+
* Request parameters for directPurchaseShipment operation in ShippingApi.
|
|
497
|
+
* @export
|
|
498
|
+
* @interface ShippingApiDirectPurchaseShipmentRequest
|
|
499
|
+
*/
|
|
500
|
+
export interface ShippingApiDirectPurchaseShipmentRequest {
|
|
501
|
+
/**
|
|
502
|
+
*
|
|
503
|
+
* @type {DirectPurchaseRequest}
|
|
504
|
+
* @memberof ShippingApiDirectPurchaseShipment
|
|
505
|
+
*/
|
|
506
|
+
readonly body: DirectPurchaseRequest;
|
|
507
|
+
/**
|
|
508
|
+
* A unique value which the server uses to recognize subsequent retries of the same request.
|
|
509
|
+
* @type {string}
|
|
510
|
+
* @memberof ShippingApiDirectPurchaseShipment
|
|
511
|
+
*/
|
|
512
|
+
readonly xAmznIdempotencyKey?: string;
|
|
513
|
+
/**
|
|
514
|
+
* 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.
|
|
515
|
+
* @type {string}
|
|
516
|
+
* @memberof ShippingApiDirectPurchaseShipment
|
|
517
|
+
*/
|
|
518
|
+
readonly locale?: string;
|
|
519
|
+
/**
|
|
520
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
521
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
522
|
+
* @memberof ShippingApiDirectPurchaseShipment
|
|
523
|
+
*/
|
|
524
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
525
|
+
}
|
|
526
|
+
/**
|
|
527
|
+
* Request parameters for generateCollectionForm operation in ShippingApi.
|
|
528
|
+
* @export
|
|
529
|
+
* @interface ShippingApiGenerateCollectionFormRequest
|
|
530
|
+
*/
|
|
531
|
+
export interface ShippingApiGenerateCollectionFormRequest {
|
|
532
|
+
/**
|
|
533
|
+
*
|
|
534
|
+
* @type {GenerateCollectionFormRequest}
|
|
535
|
+
* @memberof ShippingApiGenerateCollectionForm
|
|
536
|
+
*/
|
|
537
|
+
readonly body: GenerateCollectionFormRequest;
|
|
538
|
+
/**
|
|
539
|
+
* A unique value which the server uses to recognize subsequent retries of the same request.
|
|
540
|
+
* @type {string}
|
|
541
|
+
* @memberof ShippingApiGenerateCollectionForm
|
|
542
|
+
*/
|
|
543
|
+
readonly xAmznIdempotencyKey?: string;
|
|
544
|
+
/**
|
|
545
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
546
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
547
|
+
* @memberof ShippingApiGenerateCollectionForm
|
|
548
|
+
*/
|
|
549
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
550
|
+
}
|
|
551
|
+
/**
|
|
552
|
+
* Request parameters for getAccessPoints operation in ShippingApi.
|
|
553
|
+
* @export
|
|
554
|
+
* @interface ShippingApiGetAccessPointsRequest
|
|
555
|
+
*/
|
|
556
|
+
export interface ShippingApiGetAccessPointsRequest {
|
|
557
|
+
/**
|
|
558
|
+
*
|
|
559
|
+
* @type {Array<'HELIX' | 'CAMPUS_LOCKER' | 'OMNI_LOCKER' | 'ODIN_LOCKER' | 'DOBBY_LOCKER' | 'CORE_LOCKER' | '3P' | 'CAMPUS_ROOM'>}
|
|
560
|
+
* @memberof ShippingApiGetAccessPoints
|
|
561
|
+
*/
|
|
562
|
+
readonly accessPointTypes: Array<'HELIX' | 'CAMPUS_LOCKER' | 'OMNI_LOCKER' | 'ODIN_LOCKER' | 'DOBBY_LOCKER' | 'CORE_LOCKER' | '3P' | 'CAMPUS_ROOM'>;
|
|
563
|
+
/**
|
|
564
|
+
*
|
|
565
|
+
* @type {string}
|
|
566
|
+
* @memberof ShippingApiGetAccessPoints
|
|
567
|
+
*/
|
|
568
|
+
readonly countryCode: string;
|
|
569
|
+
/**
|
|
570
|
+
*
|
|
571
|
+
* @type {string}
|
|
572
|
+
* @memberof ShippingApiGetAccessPoints
|
|
573
|
+
*/
|
|
574
|
+
readonly postalCode: string;
|
|
575
|
+
/**
|
|
576
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
577
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
578
|
+
* @memberof ShippingApiGetAccessPoints
|
|
579
|
+
*/
|
|
580
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
581
|
+
}
|
|
582
|
+
/**
|
|
583
|
+
* Request parameters for getAdditionalInputs operation in ShippingApi.
|
|
584
|
+
* @export
|
|
585
|
+
* @interface ShippingApiGetAdditionalInputsRequest
|
|
586
|
+
*/
|
|
587
|
+
export interface ShippingApiGetAdditionalInputsRequest {
|
|
588
|
+
/**
|
|
589
|
+
* The request token returned in the response to the getRates operation.
|
|
590
|
+
* @type {string}
|
|
591
|
+
* @memberof ShippingApiGetAdditionalInputs
|
|
592
|
+
*/
|
|
593
|
+
readonly requestToken: string;
|
|
594
|
+
/**
|
|
595
|
+
* The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.
|
|
596
|
+
* @type {string}
|
|
597
|
+
* @memberof ShippingApiGetAdditionalInputs
|
|
598
|
+
*/
|
|
599
|
+
readonly rateId: string;
|
|
600
|
+
/**
|
|
601
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
602
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
603
|
+
* @memberof ShippingApiGetAdditionalInputs
|
|
604
|
+
*/
|
|
605
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
* Request parameters for getCarrierAccountFormInputs operation in ShippingApi.
|
|
609
|
+
* @export
|
|
610
|
+
* @interface ShippingApiGetCarrierAccountFormInputsRequest
|
|
611
|
+
*/
|
|
612
|
+
export interface ShippingApiGetCarrierAccountFormInputsRequest {
|
|
613
|
+
/**
|
|
614
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
615
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
616
|
+
* @memberof ShippingApiGetCarrierAccountFormInputs
|
|
617
|
+
*/
|
|
618
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
619
|
+
}
|
|
620
|
+
/**
|
|
621
|
+
* Request parameters for getCarrierAccounts operation in ShippingApi.
|
|
622
|
+
* @export
|
|
623
|
+
* @interface ShippingApiGetCarrierAccountsRequest
|
|
624
|
+
*/
|
|
625
|
+
export interface ShippingApiGetCarrierAccountsRequest {
|
|
626
|
+
/**
|
|
627
|
+
*
|
|
628
|
+
* @type {GetCarrierAccountsRequest}
|
|
629
|
+
* @memberof ShippingApiGetCarrierAccounts
|
|
630
|
+
*/
|
|
631
|
+
readonly body: GetCarrierAccountsRequest;
|
|
632
|
+
/**
|
|
633
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
634
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
635
|
+
* @memberof ShippingApiGetCarrierAccounts
|
|
636
|
+
*/
|
|
637
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* Request parameters for getCollectionForm operation in ShippingApi.
|
|
641
|
+
* @export
|
|
642
|
+
* @interface ShippingApiGetCollectionFormRequest
|
|
643
|
+
*/
|
|
644
|
+
export interface ShippingApiGetCollectionFormRequest {
|
|
645
|
+
/**
|
|
646
|
+
* collection form Id to reprint a collection.
|
|
647
|
+
* @type {string}
|
|
648
|
+
* @memberof ShippingApiGetCollectionForm
|
|
649
|
+
*/
|
|
650
|
+
readonly collectionFormId: string;
|
|
651
|
+
/**
|
|
652
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
653
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
654
|
+
* @memberof ShippingApiGetCollectionForm
|
|
655
|
+
*/
|
|
656
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
657
|
+
}
|
|
658
|
+
/**
|
|
659
|
+
* Request parameters for getCollectionFormHistory operation in ShippingApi.
|
|
660
|
+
* @export
|
|
661
|
+
* @interface ShippingApiGetCollectionFormHistoryRequest
|
|
662
|
+
*/
|
|
663
|
+
export interface ShippingApiGetCollectionFormHistoryRequest {
|
|
664
|
+
/**
|
|
665
|
+
*
|
|
666
|
+
* @type {GetCollectionFormHistoryRequest}
|
|
667
|
+
* @memberof ShippingApiGetCollectionFormHistory
|
|
668
|
+
*/
|
|
669
|
+
readonly body: GetCollectionFormHistoryRequest;
|
|
670
|
+
/**
|
|
671
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
672
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
673
|
+
* @memberof ShippingApiGetCollectionFormHistory
|
|
674
|
+
*/
|
|
675
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
676
|
+
}
|
|
677
|
+
/**
|
|
678
|
+
* Request parameters for getRates operation in ShippingApi.
|
|
679
|
+
* @export
|
|
680
|
+
* @interface ShippingApiGetRatesRequest
|
|
681
|
+
*/
|
|
682
|
+
export interface ShippingApiGetRatesRequest {
|
|
683
|
+
/**
|
|
684
|
+
*
|
|
685
|
+
* @type {GetRatesRequest}
|
|
686
|
+
* @memberof ShippingApiGetRates
|
|
687
|
+
*/
|
|
688
|
+
readonly body: GetRatesRequest;
|
|
689
|
+
/**
|
|
690
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
691
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
692
|
+
* @memberof ShippingApiGetRates
|
|
693
|
+
*/
|
|
694
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
695
|
+
}
|
|
696
|
+
/**
|
|
697
|
+
* Request parameters for getShipmentDocuments operation in ShippingApi.
|
|
698
|
+
* @export
|
|
699
|
+
* @interface ShippingApiGetShipmentDocumentsRequest
|
|
700
|
+
*/
|
|
701
|
+
export interface ShippingApiGetShipmentDocumentsRequest {
|
|
702
|
+
/**
|
|
703
|
+
* The shipment identifier originally returned by the purchaseShipment operation.
|
|
704
|
+
* @type {string}
|
|
705
|
+
* @memberof ShippingApiGetShipmentDocuments
|
|
706
|
+
*/
|
|
707
|
+
readonly shipmentId: string;
|
|
708
|
+
/**
|
|
709
|
+
* The package client reference identifier originally provided in the request body parameter for the getRates operation.
|
|
710
|
+
* @type {string}
|
|
711
|
+
* @memberof ShippingApiGetShipmentDocuments
|
|
712
|
+
*/
|
|
713
|
+
readonly packageClientReferenceId: string;
|
|
714
|
+
/**
|
|
715
|
+
* The file format of the document. Must be one of the supported formats returned by the getRates operation.
|
|
716
|
+
* @type {string}
|
|
717
|
+
* @memberof ShippingApiGetShipmentDocuments
|
|
718
|
+
*/
|
|
719
|
+
readonly format?: string;
|
|
720
|
+
/**
|
|
721
|
+
* 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.
|
|
722
|
+
* @type {number}
|
|
723
|
+
* @memberof ShippingApiGetShipmentDocuments
|
|
724
|
+
*/
|
|
725
|
+
readonly dpi?: number;
|
|
726
|
+
/**
|
|
727
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
728
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
729
|
+
* @memberof ShippingApiGetShipmentDocuments
|
|
730
|
+
*/
|
|
731
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
732
|
+
}
|
|
733
|
+
/**
|
|
734
|
+
* Request parameters for getTracking operation in ShippingApi.
|
|
735
|
+
* @export
|
|
736
|
+
* @interface ShippingApiGetTrackingRequest
|
|
737
|
+
*/
|
|
738
|
+
export interface ShippingApiGetTrackingRequest {
|
|
739
|
+
/**
|
|
740
|
+
* A carrier-generated tracking identifier originally returned by the purchaseShipment operation.
|
|
741
|
+
* @type {string}
|
|
742
|
+
* @memberof ShippingApiGetTracking
|
|
743
|
+
*/
|
|
744
|
+
readonly trackingId: string;
|
|
745
|
+
/**
|
|
746
|
+
* A carrier identifier originally returned by the getRates operation for the selected rate.
|
|
747
|
+
* @type {string}
|
|
748
|
+
* @memberof ShippingApiGetTracking
|
|
749
|
+
*/
|
|
750
|
+
readonly carrierId: string;
|
|
751
|
+
/**
|
|
752
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
753
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
754
|
+
* @memberof ShippingApiGetTracking
|
|
755
|
+
*/
|
|
756
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
757
|
+
}
|
|
758
|
+
/**
|
|
759
|
+
* Request parameters for getUnmanifestedShipments operation in ShippingApi.
|
|
760
|
+
* @export
|
|
761
|
+
* @interface ShippingApiGetUnmanifestedShipmentsRequest
|
|
762
|
+
*/
|
|
763
|
+
export interface ShippingApiGetUnmanifestedShipmentsRequest {
|
|
764
|
+
/**
|
|
765
|
+
*
|
|
766
|
+
* @type {GetUnmanifestedShipmentsRequest}
|
|
767
|
+
* @memberof ShippingApiGetUnmanifestedShipments
|
|
768
|
+
*/
|
|
769
|
+
readonly body: GetUnmanifestedShipmentsRequest;
|
|
770
|
+
/**
|
|
771
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
772
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
773
|
+
* @memberof ShippingApiGetUnmanifestedShipments
|
|
774
|
+
*/
|
|
775
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
776
|
+
}
|
|
777
|
+
/**
|
|
778
|
+
* Request parameters for linkCarrierAccount operation in ShippingApi.
|
|
779
|
+
* @export
|
|
780
|
+
* @interface ShippingApiLinkCarrierAccountRequest
|
|
781
|
+
*/
|
|
782
|
+
export interface ShippingApiLinkCarrierAccountRequest {
|
|
783
|
+
/**
|
|
784
|
+
* The unique identifier associated with the carrier account.
|
|
785
|
+
* @type {string}
|
|
786
|
+
* @memberof ShippingApiLinkCarrierAccount
|
|
787
|
+
*/
|
|
788
|
+
readonly carrierId: string;
|
|
789
|
+
/**
|
|
790
|
+
*
|
|
791
|
+
* @type {LinkCarrierAccountRequest}
|
|
792
|
+
* @memberof ShippingApiLinkCarrierAccount
|
|
793
|
+
*/
|
|
794
|
+
readonly body: LinkCarrierAccountRequest;
|
|
795
|
+
/**
|
|
796
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
797
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
798
|
+
* @memberof ShippingApiLinkCarrierAccount
|
|
799
|
+
*/
|
|
800
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
801
|
+
}
|
|
802
|
+
/**
|
|
803
|
+
* Request parameters for oneClickShipment operation in ShippingApi.
|
|
804
|
+
* @export
|
|
805
|
+
* @interface ShippingApiOneClickShipmentRequest
|
|
806
|
+
*/
|
|
807
|
+
export interface ShippingApiOneClickShipmentRequest {
|
|
808
|
+
/**
|
|
809
|
+
*
|
|
810
|
+
* @type {OneClickShipmentRequest}
|
|
811
|
+
* @memberof ShippingApiOneClickShipment
|
|
812
|
+
*/
|
|
813
|
+
readonly body: OneClickShipmentRequest;
|
|
814
|
+
/**
|
|
815
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
816
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
817
|
+
* @memberof ShippingApiOneClickShipment
|
|
818
|
+
*/
|
|
819
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
820
|
+
}
|
|
821
|
+
/**
|
|
822
|
+
* Request parameters for purchaseShipment operation in ShippingApi.
|
|
823
|
+
* @export
|
|
824
|
+
* @interface ShippingApiPurchaseShipmentRequest
|
|
825
|
+
*/
|
|
826
|
+
export interface ShippingApiPurchaseShipmentRequest {
|
|
827
|
+
/**
|
|
828
|
+
*
|
|
829
|
+
* @type {PurchaseShipmentRequest}
|
|
830
|
+
* @memberof ShippingApiPurchaseShipment
|
|
831
|
+
*/
|
|
832
|
+
readonly body: PurchaseShipmentRequest;
|
|
833
|
+
/**
|
|
834
|
+
* A unique value which the server uses to recognize subsequent retries of the same request.
|
|
835
|
+
* @type {string}
|
|
836
|
+
* @memberof ShippingApiPurchaseShipment
|
|
837
|
+
*/
|
|
838
|
+
readonly xAmznIdempotencyKey?: string;
|
|
839
|
+
/**
|
|
840
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
841
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
842
|
+
* @memberof ShippingApiPurchaseShipment
|
|
843
|
+
*/
|
|
844
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
845
|
+
}
|
|
846
|
+
/**
|
|
847
|
+
* Request parameters for unlinkCarrierAccount operation in ShippingApi.
|
|
848
|
+
* @export
|
|
849
|
+
* @interface ShippingApiUnlinkCarrierAccountRequest
|
|
850
|
+
*/
|
|
851
|
+
export interface ShippingApiUnlinkCarrierAccountRequest {
|
|
852
|
+
/**
|
|
853
|
+
* carrier Id to unlink with merchant.
|
|
854
|
+
* @type {string}
|
|
855
|
+
* @memberof ShippingApiUnlinkCarrierAccount
|
|
856
|
+
*/
|
|
857
|
+
readonly carrierId: string;
|
|
858
|
+
/**
|
|
859
|
+
*
|
|
860
|
+
* @type {UnlinkCarrierAccountRequest}
|
|
861
|
+
* @memberof ShippingApiUnlinkCarrierAccount
|
|
862
|
+
*/
|
|
863
|
+
readonly body: UnlinkCarrierAccountRequest;
|
|
864
|
+
/**
|
|
865
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
866
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
867
|
+
* @memberof ShippingApiUnlinkCarrierAccount
|
|
868
|
+
*/
|
|
869
|
+
readonly xAmznShippingBusinessId?: 'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP';
|
|
870
|
+
}
|
|
871
|
+
/**
|
|
872
|
+
* ShippingApi - object-oriented interface
|
|
873
|
+
* @export
|
|
874
|
+
* @class ShippingApi
|
|
875
|
+
* @extends {BaseAPI}
|
|
876
|
+
*/
|
|
877
|
+
export declare class ShippingApi extends BaseAPI {
|
|
878
|
+
/**
|
|
879
|
+
* 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).
|
|
880
|
+
* @param {ShippingApiCancelShipmentRequest} requestParameters Request parameters.
|
|
881
|
+
* @param {*} [options] Override http request option.
|
|
882
|
+
* @throws {RequiredError}
|
|
883
|
+
* @memberof ShippingApi
|
|
884
|
+
*/
|
|
885
|
+
cancelShipment(requestParameters: ShippingApiCancelShipmentRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<CancelShipmentResponse, any>>;
|
|
886
|
+
/**
|
|
887
|
+
* 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).
|
|
888
|
+
* @param {ShippingApiDirectPurchaseShipmentRequest} requestParameters Request parameters.
|
|
889
|
+
* @param {*} [options] Override http request option.
|
|
890
|
+
* @throws {RequiredError}
|
|
891
|
+
* @memberof ShippingApi
|
|
892
|
+
*/
|
|
893
|
+
directPurchaseShipment(requestParameters: ShippingApiDirectPurchaseShipmentRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<DirectPurchaseResponse, any>>;
|
|
894
|
+
/**
|
|
895
|
+
* 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).
|
|
896
|
+
* @param {ShippingApiGenerateCollectionFormRequest} requestParameters Request parameters.
|
|
897
|
+
* @param {*} [options] Override http request option.
|
|
898
|
+
* @throws {RequiredError}
|
|
899
|
+
* @memberof ShippingApi
|
|
900
|
+
*/
|
|
901
|
+
generateCollectionForm(requestParameters: ShippingApiGenerateCollectionFormRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GenerateCollectionFormResponse, any>>;
|
|
902
|
+
/**
|
|
903
|
+
* 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).
|
|
904
|
+
* @param {ShippingApiGetAccessPointsRequest} requestParameters Request parameters.
|
|
905
|
+
* @param {*} [options] Override http request option.
|
|
906
|
+
* @throws {RequiredError}
|
|
907
|
+
* @memberof ShippingApi
|
|
908
|
+
*/
|
|
909
|
+
getAccessPoints(requestParameters: ShippingApiGetAccessPointsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetAccessPointsResponse, any>>;
|
|
910
|
+
/**
|
|
911
|
+
* 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).
|
|
912
|
+
* @param {ShippingApiGetAdditionalInputsRequest} requestParameters Request parameters.
|
|
913
|
+
* @param {*} [options] Override http request option.
|
|
914
|
+
* @throws {RequiredError}
|
|
915
|
+
* @memberof ShippingApi
|
|
916
|
+
*/
|
|
917
|
+
getAdditionalInputs(requestParameters: ShippingApiGetAdditionalInputsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetAdditionalInputsResponse, any>>;
|
|
918
|
+
/**
|
|
919
|
+
* 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).
|
|
920
|
+
* @param {ShippingApiGetCarrierAccountFormInputsRequest} requestParameters Request parameters.
|
|
921
|
+
* @param {*} [options] Override http request option.
|
|
922
|
+
* @throws {RequiredError}
|
|
923
|
+
* @memberof ShippingApi
|
|
924
|
+
*/
|
|
925
|
+
getCarrierAccountFormInputs(requestParameters?: ShippingApiGetCarrierAccountFormInputsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCarrierAccountFormInputsResponse, any>>;
|
|
926
|
+
/**
|
|
927
|
+
* 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).
|
|
928
|
+
* @param {ShippingApiGetCarrierAccountsRequest} requestParameters Request parameters.
|
|
929
|
+
* @param {*} [options] Override http request option.
|
|
930
|
+
* @throws {RequiredError}
|
|
931
|
+
* @memberof ShippingApi
|
|
932
|
+
*/
|
|
933
|
+
getCarrierAccounts(requestParameters: ShippingApiGetCarrierAccountsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCarrierAccountsResponse, any>>;
|
|
934
|
+
/**
|
|
935
|
+
* 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).
|
|
936
|
+
* @param {ShippingApiGetCollectionFormRequest} requestParameters Request parameters.
|
|
937
|
+
* @param {*} [options] Override http request option.
|
|
938
|
+
* @throws {RequiredError}
|
|
939
|
+
* @memberof ShippingApi
|
|
940
|
+
*/
|
|
941
|
+
getCollectionForm(requestParameters: ShippingApiGetCollectionFormRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCollectionFormResponse, any>>;
|
|
942
|
+
/**
|
|
943
|
+
* 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).
|
|
944
|
+
* @param {ShippingApiGetCollectionFormHistoryRequest} requestParameters Request parameters.
|
|
945
|
+
* @param {*} [options] Override http request option.
|
|
946
|
+
* @throws {RequiredError}
|
|
947
|
+
* @memberof ShippingApi
|
|
948
|
+
*/
|
|
949
|
+
getCollectionFormHistory(requestParameters: ShippingApiGetCollectionFormHistoryRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCollectionFormHistoryResponse, any>>;
|
|
950
|
+
/**
|
|
951
|
+
* 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).
|
|
952
|
+
* @param {ShippingApiGetRatesRequest} requestParameters Request parameters.
|
|
953
|
+
* @param {*} [options] Override http request option.
|
|
954
|
+
* @throws {RequiredError}
|
|
955
|
+
* @memberof ShippingApi
|
|
956
|
+
*/
|
|
957
|
+
getRates(requestParameters: ShippingApiGetRatesRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetRatesResponse, any>>;
|
|
958
|
+
/**
|
|
959
|
+
* 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).
|
|
960
|
+
* @param {ShippingApiGetShipmentDocumentsRequest} requestParameters Request parameters.
|
|
961
|
+
* @param {*} [options] Override http request option.
|
|
962
|
+
* @throws {RequiredError}
|
|
963
|
+
* @memberof ShippingApi
|
|
964
|
+
*/
|
|
965
|
+
getShipmentDocuments(requestParameters: ShippingApiGetShipmentDocumentsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentDocumentsResponse, any>>;
|
|
966
|
+
/**
|
|
967
|
+
* 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).
|
|
968
|
+
* @param {ShippingApiGetTrackingRequest} requestParameters Request parameters.
|
|
969
|
+
* @param {*} [options] Override http request option.
|
|
970
|
+
* @throws {RequiredError}
|
|
971
|
+
* @memberof ShippingApi
|
|
972
|
+
*/
|
|
973
|
+
getTracking(requestParameters: ShippingApiGetTrackingRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetTrackingResponse, any>>;
|
|
974
|
+
/**
|
|
975
|
+
* 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).
|
|
976
|
+
* @param {ShippingApiGetUnmanifestedShipmentsRequest} requestParameters Request parameters.
|
|
977
|
+
* @param {*} [options] Override http request option.
|
|
978
|
+
* @throws {RequiredError}
|
|
979
|
+
* @memberof ShippingApi
|
|
980
|
+
*/
|
|
981
|
+
getUnmanifestedShipments(requestParameters: ShippingApiGetUnmanifestedShipmentsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetUnmanifestedShipmentsResponse, any>>;
|
|
982
|
+
/**
|
|
983
|
+
* 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).
|
|
984
|
+
* @param {ShippingApiLinkCarrierAccountRequest} requestParameters Request parameters.
|
|
985
|
+
* @param {*} [options] Override http request option.
|
|
986
|
+
* @throws {RequiredError}
|
|
987
|
+
* @memberof ShippingApi
|
|
988
|
+
*/
|
|
989
|
+
linkCarrierAccount(requestParameters: ShippingApiLinkCarrierAccountRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<LinkCarrierAccountResponse, any>>;
|
|
990
|
+
/**
|
|
991
|
+
* 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).
|
|
992
|
+
* @param {ShippingApiOneClickShipmentRequest} requestParameters Request parameters.
|
|
993
|
+
* @param {*} [options] Override http request option.
|
|
994
|
+
* @throws {RequiredError}
|
|
995
|
+
* @memberof ShippingApi
|
|
996
|
+
*/
|
|
997
|
+
oneClickShipment(requestParameters: ShippingApiOneClickShipmentRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<OneClickShipmentResponse, any>>;
|
|
998
|
+
/**
|
|
999
|
+
* 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).
|
|
1000
|
+
* @param {ShippingApiPurchaseShipmentRequest} requestParameters Request parameters.
|
|
1001
|
+
* @param {*} [options] Override http request option.
|
|
1002
|
+
* @throws {RequiredError}
|
|
1003
|
+
* @memberof ShippingApi
|
|
1004
|
+
*/
|
|
1005
|
+
purchaseShipment(requestParameters: ShippingApiPurchaseShipmentRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<PurchaseShipmentResponse, any>>;
|
|
1006
|
+
/**
|
|
1007
|
+
* 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).
|
|
1008
|
+
* @param {ShippingApiUnlinkCarrierAccountRequest} requestParameters Request parameters.
|
|
1009
|
+
* @param {*} [options] Override http request option.
|
|
1010
|
+
* @throws {RequiredError}
|
|
1011
|
+
* @memberof ShippingApi
|
|
1012
|
+
*/
|
|
1013
|
+
unlinkCarrierAccount(requestParameters: ShippingApiUnlinkCarrierAccountRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<UnlinkCarrierAccountResponse, any>>;
|
|
1014
|
+
}
|