@sp-api-sdk/shipping-api-v2 1.1.0

package/dist/types/src/api-model/models/get-collection-form-history-request.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Address } from './address';
+import { ClientReferenceDetail } from './client-reference-detail';
+import { DateRange } from './date-range';
+/**
+ * The request schema to get query collections form history API .
+ * @export
+ * @interface GetCollectionFormHistoryRequest
+ */
+export interface GetCollectionFormHistoryRequest {
+    /**
+     * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
+     * @type {Array<ClientReferenceDetail>}
+     * @memberof GetCollectionFormHistoryRequest
+     */
+    'clientReferenceDetails'?: Array<ClientReferenceDetail>;
+    /**
+     * max Number of Results for query .
+     * @type {number}
+     * @memberof GetCollectionFormHistoryRequest
+     */
+    'maxResults'?: number;
+    /**
+     * The carrier identifier for the offering, provided by the carrier.
+     * @type {string}
+     * @memberof GetCollectionFormHistoryRequest
+     */
+    'carrierId'?: string;
+    /**
+     *
+     * @type {Address}
+     * @memberof GetCollectionFormHistoryRequest
+     */
+    'shipFromAddress'?: Address;
+    /**
+     *
+     * @type {DateRange}
+     * @memberof GetCollectionFormHistoryRequest
+     */
+    'dateRange'?: DateRange;
+}

package/dist/types/src/api-model/models/get-collection-form-history-response.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CollectionFormsHistoryRecord } from './collection-forms-history-record';
+/**
+ * The Response  for the GetCollectionFormHistoryResponse operation.
+ * @export
+ * @interface GetCollectionFormHistoryResponse
+ */
+export interface GetCollectionFormHistoryResponse {
+    /**
+     * A list of CollectionFormsHistoryRecord
+     * @type {Array<CollectionFormsHistoryRecord>}
+     * @memberof GetCollectionFormHistoryResponse
+     */
+    'collectionFormsHistoryRecordList'?: Array<CollectionFormsHistoryRecord>;
+    /**
+     * Last Refereshed Date of collection
+     * @type {string}
+     * @memberof GetCollectionFormHistoryResponse
+     */
+    'lastRefreshedDate'?: string;
+}

package/dist/types/src/api-model/models/get-collection-form-response.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CollectionsFormDocument } from './collections-form-document';
+/**
+ * The Response  for the GetCollectionFormResponse operation.
+ * @export
+ * @interface GetCollectionFormResponse
+ */
+export interface GetCollectionFormResponse {
+    /**
+     *
+     * @type {CollectionsFormDocument}
+     * @memberof GetCollectionFormResponse
+     */
+    'collectionsFormDocument'?: CollectionsFormDocument;
+}

package/dist/types/src/api-model/models/get-rates-request.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AccessPointDetails } from './access-point-details';
+import { Address } from './address';
+import { ChannelDetails } from './channel-details';
+import { ClientReferenceDetail } from './client-reference-detail';
+import { Package } from './package';
+import { ShipmentType } from './shipment-type';
+import { ShipperInstruction } from './shipper-instruction';
+import { TaxDetail } from './tax-detail';
+import { ValueAddedServiceDetails } from './value-added-service-details';
+/**
+ * The request schema for the getRates operation. When the channelType is Amazon, the shipTo address is not required and will be ignored.
+ * @export
+ * @interface GetRatesRequest
+ */
+export interface GetRatesRequest {
+    /**
+     *
+     * @type {Address}
+     * @memberof GetRatesRequest
+     */
+    'shipTo'?: Address;
+    /**
+     *
+     * @type {Address}
+     * @memberof GetRatesRequest
+     */
+    'shipFrom': Address;
+    /**
+     *
+     * @type {Address}
+     * @memberof GetRatesRequest
+     */
+    'returnTo'?: Address;
+    /**
+     * The ship date and time (the requested pickup). This defaults to the current date and time.
+     * @type {string}
+     * @memberof GetRatesRequest
+     */
+    'shipDate'?: string;
+    /**
+     *
+     * @type {ShipperInstruction}
+     * @memberof GetRatesRequest
+     */
+    'shipperInstruction'?: ShipperInstruction;
+    /**
+     * A list of packages to be shipped through a shipping service offering.
+     * @type {Array<Package>}
+     * @memberof GetRatesRequest
+     */
+    'packages': Array<Package>;
+    /**
+     *
+     * @type {ValueAddedServiceDetails}
+     * @memberof GetRatesRequest
+     */
+    'valueAddedServices'?: ValueAddedServiceDetails;
+    /**
+     * A list of tax detail information.
+     * @type {Array<TaxDetail>}
+     * @memberof GetRatesRequest
+     */
+    'taxDetails'?: Array<TaxDetail>;
+    /**
+     *
+     * @type {ChannelDetails}
+     * @memberof GetRatesRequest
+     */
+    'channelDetails': ChannelDetails;
+    /**
+     * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
+     * @type {Array<ClientReferenceDetail>}
+     * @memberof GetRatesRequest
+     */
+    'clientReferenceDetails'?: Array<ClientReferenceDetail>;
+    /**
+     *
+     * @type {ShipmentType}
+     * @memberof GetRatesRequest
+     */
+    'shipmentType'?: ShipmentType;
+    /**
+     *
+     * @type {AccessPointDetails}
+     * @memberof GetRatesRequest
+     */
+    'destinationAccessPointDetails'?: AccessPointDetails;
+}

package/dist/types/src/api-model/models/get-rates-response.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GetRatesResult } from './get-rates-result';
+/**
+ * The response schema for the getRates operation.
+ * @export
+ * @interface GetRatesResponse
+ */
+export interface GetRatesResponse {
+    /**
+     *
+     * @type {GetRatesResult}
+     * @memberof GetRatesResponse
+     */
+    'payload'?: GetRatesResult;
+}

package/dist/types/src/api-model/models/get-rates-result.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { IneligibleRate } from './ineligible-rate';
+import { Rate } from './rate';
+/**
+ * The payload for the getRates operation.
+ * @export
+ * @interface GetRatesResult
+ */
+export interface GetRatesResult {
+    /**
+     * A unique token generated to identify a getRates operation.
+     * @type {string}
+     * @memberof GetRatesResult
+     */
+    'requestToken': string;
+    /**
+     * A list of eligible shipping service offerings.
+     * @type {Array<Rate>}
+     * @memberof GetRatesResult
+     */
+    'rates': Array<Rate>;
+    /**
+     * A list of ineligible shipping service offerings.
+     * @type {Array<IneligibleRate>}
+     * @memberof GetRatesResult
+     */
+    'ineligibleRates'?: Array<IneligibleRate>;
+}

package/dist/types/src/api-model/models/get-shipment-documents-response.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GetShipmentDocumentsResult } from './get-shipment-documents-result';
+/**
+ * The response schema for the the getShipmentDocuments operation.
+ * @export
+ * @interface GetShipmentDocumentsResponse
+ */
+export interface GetShipmentDocumentsResponse {
+    /**
+     *
+     * @type {GetShipmentDocumentsResult}
+     * @memberof GetShipmentDocumentsResponse
+     */
+    'payload'?: GetShipmentDocumentsResult;
+}

package/dist/types/src/api-model/models/get-shipment-documents-result.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PackageDocumentDetail } from './package-document-detail';
+/**
+ * The payload for the getShipmentDocuments operation.
+ * @export
+ * @interface GetShipmentDocumentsResult
+ */
+export interface GetShipmentDocumentsResult {
+    /**
+     * The unique shipment identifier provided by a shipping service.
+     * @type {string}
+     * @memberof GetShipmentDocumentsResult
+     */
+    'shipmentId': string;
+    /**
+     *
+     * @type {PackageDocumentDetail}
+     * @memberof GetShipmentDocumentsResult
+     */
+    'packageDocumentDetail': PackageDocumentDetail;
+}

package/dist/types/src/api-model/models/get-tracking-response.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GetTrackingResult } from './get-tracking-result';
+/**
+ * The response schema for the getTracking operation.
+ * @export
+ * @interface GetTrackingResponse
+ */
+export interface GetTrackingResponse {
+    /**
+     *
+     * @type {GetTrackingResult}
+     * @memberof GetTrackingResponse
+     */
+    'payload'?: GetTrackingResult;
+}

package/dist/types/src/api-model/models/get-tracking-result.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Event } from './event';
+import { TrackingSummary } from './tracking-summary';
+/**
+ * The payload for the getTracking operation.
+ * @export
+ * @interface GetTrackingResult
+ */
+export interface GetTrackingResult {
+    /**
+     * The carrier generated identifier for a package in a purchased shipment.
+     * @type {string}
+     * @memberof GetTrackingResult
+     */
+    'trackingId': string;
+    /**
+     * The carrier generated reverse identifier for a returned package in a purchased shipment.
+     * @type {string}
+     * @memberof GetTrackingResult
+     */
+    'alternateLegTrackingId': string;
+    /**
+     * A list of tracking events.
+     * @type {Array<Event>}
+     * @memberof GetTrackingResult
+     */
+    'eventHistory': Array<Event>;
+    /**
+     * The date and time by which the shipment is promised to be delivered.
+     * @type {string}
+     * @memberof GetTrackingResult
+     */
+    'promisedDeliveryDate': string;
+    /**
+     *
+     * @type {TrackingSummary}
+     * @memberof GetTrackingResult
+     */
+    'summary': TrackingSummary;
+}

package/dist/types/src/api-model/models/get-unmanifested-shipments-request.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ClientReferenceDetail } from './client-reference-detail';
+/**
+ * The request schema for the GetUnmanifestedShipmentsRequest operation.
+ * @export
+ * @interface GetUnmanifestedShipmentsRequest
+ */
+export interface GetUnmanifestedShipmentsRequest {
+    /**
+     * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
+     * @type {Array<ClientReferenceDetail>}
+     * @memberof GetUnmanifestedShipmentsRequest
+     */
+    'clientReferenceDetails'?: Array<ClientReferenceDetail>;
+}

package/dist/types/src/api-model/models/get-unmanifested-shipments-response.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { UnmanifestedCarrierInformation } from './unmanifested-carrier-information';
+/**
+ * The Response  for the GetUnmanifestedShipmentsResponse operation.
+ * @export
+ * @interface GetUnmanifestedShipmentsResponse
+ */
+export interface GetUnmanifestedShipmentsResponse {
+    /**
+     * A list of UnmanifestedCarrierInformation
+     * @type {Array<UnmanifestedCarrierInformation>}
+     * @memberof GetUnmanifestedShipmentsResponse
+     */
+    'unmanifestedCarrierInformationList'?: Array<UnmanifestedCarrierInformation>;
+}

package/dist/types/src/api-model/models/index.d.ts

@@ -0,0 +1,114 @@
+export * from './access-point';
+export * from './access-point-details';
+export * from './access-point-type';
+export * from './accessibility-attributes';
+export * from './account-status';
+export * from './account-type';
+export * from './active-account';
+export * from './address';
+export * from './amazon-order-details';
+export * from './amazon-shipment-details';
+export * from './available-value-added-service-group';
+export * from './benefits';
+export * from './cancel-shipment-response';
+export * from './carrier';
+export * from './carrier-account-attribute';
+export * from './carrier-account-input';
+export * from './channel-details';
+export * from './channel-type';
+export * from './charge-component';
+export * from './client-reference-detail';
+export * from './collect-on-delivery';
+export * from './collection-forms-history-record';
+export * from './collections-form-document';
+export * from './currency';
+export * from './dangerous-goods-details';
+export * from './date-range';
+export * from './dimensions';
+export * from './direct-fulfillment-item-identifiers';
+export * from './direct-purchase-request';
+export * from './direct-purchase-response';
+export * from './direct-purchase-result';
+export * from './document-format';
+export * from './document-size';
+export * from './document-type';
+export * from './error-list';
+export * from './event';
+export * from './event-code';
+export * from './exception-operating-hours';
+export * from './excluded-benefit';
+export * from './generate-collection-form-request';
+export * from './generate-collection-form-response';
+export * from './generation-status';
+export * from './geocode';
+export * from './get-access-points-response';
+export * from './get-access-points-result';
+export * from './get-additional-inputs-response';
+export * from './get-carrier-account-form-inputs-response';
+export * from './get-carrier-accounts-request';
+export * from './get-carrier-accounts-response';
+export * from './get-collection-form-history-request';
+export * from './get-collection-form-history-response';
+export * from './get-collection-form-response';
+export * from './get-rates-request';
+export * from './get-rates-response';
+export * from './get-rates-result';
+export * from './get-shipment-documents-response';
+export * from './get-shipment-documents-result';
+export * from './get-tracking-response';
+export * from './get-tracking-result';
+export * from './get-unmanifested-shipments-request';
+export * from './get-unmanifested-shipments-response';
+export * from './ineligibility-reason';
+export * from './ineligibility-reason-code';
+export * from './ineligible-rate';
+export * from './input-type';
+export * from './invoice-details';
+export * from './item';
+export * from './link-carrier-account-request';
+export * from './link-carrier-account-response';
+export * from './linkable-account-type';
+export * from './linkable-carrier';
+export * from './liquid-volume';
+export * from './location';
+export * from './model-error';
+export * from './one-click-shipment-request';
+export * from './one-click-shipment-response';
+export * from './one-click-shipment-result';
+export * from './one-click-shipment-value-added-service';
+export * from './operating-hours';
+export * from './package';
+export * from './package-document';
+export * from './package-document-detail';
+export * from './payment-type';
+export * from './print-option';
+export * from './promise';
+export * from './purchase-shipment-request';
+export * from './purchase-shipment-response';
+export * from './purchase-shipment-result';
+export * from './rate';
+export * from './rate-item';
+export * from './rate-item-id';
+export * from './rate-item-type';
+export * from './requested-document-specification';
+export * from './requested-value-added-service';
+export * from './service';
+export * from './service-selection';
+export * from './shipment-type';
+export * from './shipper-instruction';
+export * from './status';
+export * from './supported-document-detail';
+export * from './supported-document-specification';
+export * from './tax-detail';
+export * from './tax-type';
+export * from './time-of-day';
+export * from './time-window';
+export * from './tracking-summary';
+export * from './unlink-carrier-account-request';
+export * from './unlink-carrier-account-response';
+export * from './unmanifested-carrier-information';
+export * from './unmanifested-shipment-location';
+export * from './validation-metadata';
+export * from './value-added-service';
+export * from './value-added-service-details';
+export * from './weight';

package/dist/types/src/api-model/models/ineligibility-reason-code.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Reasons that make a shipment service offering ineligible.
+ * @export
+ * @enum {string}
+ */
+export declare const IneligibilityReasonCode: {
+    readonly NoCoverage: "NO_COVERAGE";
+    readonly PickupSlotRestriction: "PICKUP_SLOT_RESTRICTION";
+    readonly UnsupportedVas: "UNSUPPORTED_VAS";
+    readonly VasCombinationRestriction: "VAS_COMBINATION_RESTRICTION";
+    readonly SizeRestrictions: "SIZE_RESTRICTIONS";
+    readonly WeightRestrictions: "WEIGHT_RESTRICTIONS";
+    readonly LateDelivery: "LATE_DELIVERY";
+    readonly ProgramConstraints: "PROGRAM_CONSTRAINTS";
+    readonly TermsAndConditionsNotAccepted: "TERMS_AND_CONDITIONS_NOT_ACCEPTED";
+    readonly Unknown: "UNKNOWN";
+};
+export type IneligibilityReasonCode = typeof IneligibilityReasonCode[keyof typeof IneligibilityReasonCode];

package/dist/types/src/api-model/models/ineligibility-reason.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Amazon Shipping API
+ * 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.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { IneligibilityReasonCode } from './ineligibility-reason-code';
+/**
+ * The reason why a shipping service offering is ineligible.
+ * @export
+ * @interface IneligibilityReason
+ */
+export interface IneligibilityReason {
+    /**
+     *
+     * @type {IneligibilityReasonCode}
+     * @memberof IneligibilityReason
+     */
+    'code': IneligibilityReasonCode;
+    /**
+     * The ineligibility reason.
+     * @type {string}
+     * @memberof IneligibilityReason
+     */
+    'message': string;
+}