@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
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2021 Bizon
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# `shipping-api-v2`
|
|
2
|
+
|
|
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
|
+
[](https://www.npmjs.com/package/@sp-api-sdk/shipping-api-v2)
|
|
6
|
+
[](https://github.com/xojs/xo)
|
|
7
|
+
|
|
8
|
+
## Documentation
|
|
9
|
+
|
|
10
|
+
Learn more about this Selling Partner API by visiting the [official documentation](https://developer-docs.amazon.com/sp-api/docs).
|
|
11
|
+
|
|
12
|
+
Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_shipping_api_v2.html) for this API client.
|
|
13
|
+
|
|
14
|
+
## Installing
|
|
15
|
+
|
|
16
|
+
```sh
|
|
17
|
+
npm install @sp-api-sdk/shipping-api-v2
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Getting Started
|
|
21
|
+
|
|
22
|
+
```javascript
|
|
23
|
+
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
|
|
24
|
+
import {ShippingApiClient} from '@sp-api-sdk/shipping-api-v2'
|
|
25
|
+
|
|
26
|
+
const auth = new SellingPartnerApiAuth({
|
|
27
|
+
clientId: process.env.LWA_CLIENT_ID,
|
|
28
|
+
clientSecret: process.env.LWA_CLIENT_SECRET,
|
|
29
|
+
refreshToken: 'Atzr|…',
|
|
30
|
+
})
|
|
31
|
+
|
|
32
|
+
const client = new ShippingApiClient({
|
|
33
|
+
auth,
|
|
34
|
+
region: 'eu',
|
|
35
|
+
})
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Rate Limiting
|
|
39
|
+
|
|
40
|
+
In order to retry rate limited requests (HTTP 429), you can configure the API client as such:
|
|
41
|
+
|
|
42
|
+
```javascript
|
|
43
|
+
const client = new ShippingApiClient({
|
|
44
|
+
auth,
|
|
45
|
+
region: 'eu',
|
|
46
|
+
rateLimiting: {
|
|
47
|
+
retry: true,
|
|
48
|
+
// Optionally specify a callback that will be called on every retry.
|
|
49
|
+
onRetry: (retryInfo) => {
|
|
50
|
+
console.log(retryInfo)
|
|
51
|
+
},
|
|
52
|
+
},
|
|
53
|
+
})
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The rate limits used for each route are specified in the [API documentation](https://developer-docs.amazon.com/sp-api/docs).
|
|
57
|
+
|
|
58
|
+
## Logging
|
|
59
|
+
|
|
60
|
+
You can enable logging for both SP-API requests and responses by configuring the `logging.request` and `logging.response` properties.
|
|
61
|
+
|
|
62
|
+
```javascript
|
|
63
|
+
const client = new ShippingApiClient({
|
|
64
|
+
auth,
|
|
65
|
+
region: 'eu',
|
|
66
|
+
logging: {
|
|
67
|
+
request: {
|
|
68
|
+
logger: console.debug
|
|
69
|
+
},
|
|
70
|
+
response: {
|
|
71
|
+
logger: console.debug
|
|
72
|
+
},
|
|
73
|
+
error: true,
|
|
74
|
+
},
|
|
75
|
+
})
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Specifying `true` will use the default options, specifying an object will allow you to override the default options.
|
|
79
|
+
This uses [axios-logger](https://github.com/hg-pyun/axios-logger) under the hood.
|
|
80
|
+
By default, if enabled, the `request` and `response` loggers will use `console.info` and the `error` logger will use `console.error`.
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
## License
|
|
84
|
+
|
|
85
|
+
MIT
|
|
86
|
+
|
|
87
|
+
## Miscellaneous
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
╚⊙ ⊙╝
|
|
91
|
+
╚═(███)═╝
|
|
92
|
+
╚═(███)═╝
|
|
93
|
+
╚═(███)═╝
|
|
94
|
+
╚═(███)═╝
|
|
95
|
+
╚═(███)═╝
|
|
96
|
+
╚═(███)═╝
|
|
97
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./src/client"), exports);
|
|
18
|
+
__exportStar(require("./src/api-model/models"), exports);
|