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

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

@@ -0,0 +1,37 @@
+/**
+ * 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 { TimeOfDay } from './time-of-day';
+/**
+ * The hours in which the access point shall remain operational
+ * @export
+ * @interface OperatingHours
+ */
+export interface OperatingHours {
+    /**
+     *
+     * @type {TimeOfDay}
+     * @memberof OperatingHours
+     */
+    'closingTime'?: TimeOfDay;
+    /**
+     *
+     * @type {TimeOfDay}
+     * @memberof OperatingHours
+     */
+    'openingTime'?: TimeOfDay;
+    /**
+     *
+     * @type {Array<TimeOfDay>}
+     * @memberof OperatingHours
+     */
+    'midDayClosures'?: Array<TimeOfDay>;
+}

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

@@ -0,0 +1,37 @@
+/**
+ * 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 { PackageDocument } from './package-document';
+/**
+ * The post-purchase details of a package that will be shipped using a shipping service.
+ * @export
+ * @interface PackageDocumentDetail
+ */
+export interface PackageDocumentDetail {
+    /**
+     * A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation.
+     * @type {string}
+     * @memberof PackageDocumentDetail
+     */
+    'packageClientReferenceId': string;
+    /**
+     * A list of documents related to a package.
+     * @type {Array<PackageDocument>}
+     * @memberof PackageDocumentDetail
+     */
+    'packageDocuments': Array<PackageDocument>;
+    /**
+     * The carrier generated identifier for a package in a purchased shipment.
+     * @type {string}
+     * @memberof PackageDocumentDetail
+     */
+    'trackingId'?: string;
+}

package/dist/types/src/api-model/models/package-document.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 { DocumentFormat } from './document-format';
+import { DocumentType } from './document-type';
+/**
+ * A document related to a package.
+ * @export
+ * @interface PackageDocument
+ */
+export interface PackageDocument {
+    /**
+     *
+     * @type {DocumentType}
+     * @memberof PackageDocument
+     */
+    'type': DocumentType;
+    /**
+     *
+     * @type {DocumentFormat}
+     * @memberof PackageDocument
+     */
+    'format': DocumentFormat;
+    /**
+     * A Base64 encoded string of the file contents.
+     * @type {string}
+     * @memberof PackageDocument
+     */
+    'contents': string;
+}

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

@@ -0,0 +1,71 @@
+/**
+ * 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 { ChargeComponent } from './charge-component';
+import { Currency } from './currency';
+import { Dimensions } from './dimensions';
+import { Item } from './item';
+import { Weight } from './weight';
+/**
+ * A package to be shipped through a shipping service offering.
+ * @export
+ * @interface Package
+ */
+export interface Package {
+    /**
+     *
+     * @type {Dimensions}
+     * @memberof Package
+     */
+    'dimensions': Dimensions;
+    /**
+     *
+     * @type {Weight}
+     * @memberof Package
+     */
+    'weight': Weight;
+    /**
+     *
+     * @type {Currency}
+     * @memberof Package
+     */
+    'insuredValue': Currency;
+    /**
+     * When true, the package contains hazardous materials. Defaults to false.
+     * @type {boolean}
+     * @memberof Package
+     */
+    'isHazmat'?: boolean;
+    /**
+     * The seller name displayed on the label.
+     * @type {string}
+     * @memberof Package
+     */
+    'sellerDisplayName'?: string;
+    /**
+     * A list of charges based on the shipping service charges applied on a package.
+     * @type {Array<ChargeComponent>}
+     * @memberof Package
+     */
+    'charges'?: Array<ChargeComponent>;
+    /**
+     * A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation.
+     * @type {string}
+     * @memberof Package
+     */
+    'packageClientReferenceId': string;
+    /**
+     * A list of items.
+     * @type {Array<Item>}
+     * @memberof Package
+     */
+    'items': Array<Item>;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+/**
+ * Payment type of the purchase.
+ * @export
+ * @enum {string}
+ */
+export declare const PaymentType: {
+    readonly ThroughAmazon: "PAY_THROUGH_AMAZON";
+    readonly DirectToCarrier: "PAY_DIRECT_TO_CARRIER";
+};
+export type PaymentType = typeof PaymentType[keyof typeof PaymentType];

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

@@ -0,0 +1,43 @@
+/**
+ * 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 { SupportedDocumentDetail } from './supported-document-detail';
+/**
+ * The format options available for a label.
+ * @export
+ * @interface PrintOption
+ */
+export interface PrintOption {
+    /**
+     * A list of the supported DPI options for a document.
+     * @type {Array<number>}
+     * @memberof PrintOption
+     */
+    'supportedDPIs'?: Array<number>;
+    /**
+     * A list of the supported page layout options for a document.
+     * @type {Array<string>}
+     * @memberof PrintOption
+     */
+    'supportedPageLayouts': Array<string>;
+    /**
+     * A list of the supported needFileJoining boolean values for a document.
+     * @type {Array<boolean>}
+     * @memberof PrintOption
+     */
+    'supportedFileJoiningOptions': Array<boolean>;
+    /**
+     * A list of the supported documented details.
+     * @type {Array<SupportedDocumentDetail>}
+     * @memberof PrintOption
+     */
+    'supportedDocumentDetails': Array<SupportedDocumentDetail>;
+}

package/dist/types/src/api-model/models/promise.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 { TimeWindow } from './time-window';
+/**
+ * The time windows promised for pickup and delivery events.
+ * @export
+ * @interface Promise
+ */
+export interface Promise {
+    /**
+     *
+     * @type {TimeWindow}
+     * @memberof Promise
+     */
+    'deliveryWindow'?: TimeWindow;
+    /**
+     *
+     * @type {TimeWindow}
+     * @memberof Promise
+     */
+    'pickupWindow'?: TimeWindow;
+}

package/dist/types/src/api-model/models/purchase-shipment-request.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { RequestedDocumentSpecification } from './requested-document-specification';
+import { RequestedValueAddedService } from './requested-value-added-service';
+/**
+ * The request schema for the purchaseShipment operation.
+ * @export
+ * @interface PurchaseShipmentRequest
+ */
+export interface PurchaseShipmentRequest {
+    /**
+     * A unique token generated to identify a getRates operation.
+     * @type {string}
+     * @memberof PurchaseShipmentRequest
+     */
+    'requestToken': string;
+    /**
+     * An identifier for the rate (shipment offering) provided by a shipping service provider.
+     * @type {string}
+     * @memberof PurchaseShipmentRequest
+     */
+    'rateId': string;
+    /**
+     *
+     * @type {RequestedDocumentSpecification}
+     * @memberof PurchaseShipmentRequest
+     */
+    'requestedDocumentSpecification': RequestedDocumentSpecification;
+    /**
+     * The value-added services to be added to a shipping service purchase.
+     * @type {Array<RequestedValueAddedService>}
+     * @memberof PurchaseShipmentRequest
+     */
+    'requestedValueAddedServices'?: Array<RequestedValueAddedService>;
+    /**
+     * The additional inputs required to purchase a shipping offering, in JSON format. The JSON provided here must adhere to the JSON schema that is returned in the response to the getAdditionalInputs operation.  Additional inputs are only required when indicated by the requiresAdditionalInputs property in the response to the getRates operation.
+     * @type {{ [key: string]: object; }}
+     * @memberof PurchaseShipmentRequest
+     */
+    'additionalInputs'?: {
+        [key: string]: object;
+    };
+}

package/dist/types/src/api-model/models/purchase-shipment-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 { PurchaseShipmentResult } from './purchase-shipment-result';
+/**
+ * The response schema for the purchaseShipment operation.
+ * @export
+ * @interface PurchaseShipmentResponse
+ */
+export interface PurchaseShipmentResponse {
+    /**
+     *
+     * @type {PurchaseShipmentResult}
+     * @memberof PurchaseShipmentResponse
+     */
+    'payload'?: PurchaseShipmentResult;
+}

package/dist/types/src/api-model/models/purchase-shipment-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 { PackageDocumentDetail } from './package-document-detail';
+import { Promise } from './promise';
+/**
+ * The payload for the purchaseShipment operation.
+ * @export
+ * @interface PurchaseShipmentResult
+ */
+export interface PurchaseShipmentResult {
+    /**
+     * The unique shipment identifier provided by a shipping service.
+     * @type {string}
+     * @memberof PurchaseShipmentResult
+     */
+    'shipmentId': string;
+    /**
+     * A list of post-purchase details about a package that will be shipped using a shipping service.
+     * @type {Array<PackageDocumentDetail>}
+     * @memberof PurchaseShipmentResult
+     */
+    'packageDocumentDetails': Array<PackageDocumentDetail>;
+    /**
+     *
+     * @type {Promise}
+     * @memberof PurchaseShipmentResult
+     */
+    'promise': Promise;
+}

package/dist/types/src/api-model/models/rate-item-id.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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.
+ */
+/**
+ * Unique ID for the rateItem.
+ * @export
+ * @enum {string}
+ */
+export declare const RateItemID: {
+    readonly BaseRate: "BASE_RATE";
+    readonly TransactionFee: "TRANSACTION_FEE";
+    readonly AdultSignatureConfirmation: "ADULT_SIGNATURE_CONFIRMATION";
+    readonly SignatureConfirmation: "SIGNATURE_CONFIRMATION";
+    readonly NoConfirmation: "NO_CONFIRMATION";
+    readonly WaiveSignature: "WAIVE_SIGNATURE";
+    readonly ImpliedLiability: "IMPLIED_LIABILITY";
+    readonly HiddenPostage: "HIDDEN_POSTAGE";
+    readonly DeclaredValue: "DECLARED_VALUE";
+    readonly SundayHolidayDelivery: "SUNDAY_HOLIDAY_DELIVERY";
+    readonly DeliveryConfirmation: "DELIVERY_CONFIRMATION";
+    readonly ImportDutyCharge: "IMPORT_DUTY_CHARGE";
+    readonly Vat: "VAT";
+    readonly NoSaturdayDelivery: "NO_SATURDAY_DELIVERY";
+    readonly Insurance: "INSURANCE";
+    readonly Cod: "COD";
+    readonly FuelSurcharge: "FUEL_SURCHARGE";
+    readonly InspectionCharge: "INSPECTION_CHARGE";
+    readonly DeliveryAreaSurcharge: "DELIVERY_AREA_SURCHARGE";
+    readonly WaybillCharge: "WAYBILL_CHARGE";
+    readonly AmazonSponsoredDiscount: "AMAZON_SPONSORED_DISCOUNT";
+    readonly IntegratorSponsoredDiscount: "INTEGRATOR_SPONSORED_DISCOUNT";
+    readonly OversizeSurcharge: "OVERSIZE_SURCHARGE";
+    readonly CongestionCharge: "CONGESTION_CHARGE";
+    readonly ResidentialSurcharge: "RESIDENTIAL_SURCHARGE";
+    readonly AdditionalSurcharge: "ADDITIONAL_SURCHARGE";
+    readonly Surcharge: "SURCHARGE";
+    readonly Rebate: "REBATE";
+};
+export type RateItemID = typeof RateItemID[keyof typeof RateItemID];

package/dist/types/src/api-model/models/rate-item-type.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+/**
+ * Type of the rateItem.
+ * @export
+ * @enum {string}
+ */
+export declare const RateItemType: {
+    readonly Mandatory: "MANDATORY";
+    readonly Optional: "OPTIONAL";
+    readonly Included: "INCLUDED";
+};
+export type RateItemType = typeof RateItemType[keyof typeof RateItemType];

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

@@ -0,0 +1,45 @@
+/**
+ * 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 { Currency } from './currency';
+import { RateItemID } from './rate-item-id';
+import { RateItemType } from './rate-item-type';
+/**
+ * Rate Item for shipping (base cost, transaction fee, confirmation, insurance, etc.) Data source definition:
+ * @export
+ * @interface RateItem
+ */
+export interface RateItem {
+    /**
+     *
+     * @type {RateItemID}
+     * @memberof RateItem
+     */
+    'rateItemID'?: RateItemID;
+    /**
+     *
+     * @type {RateItemType}
+     * @memberof RateItem
+     */
+    'rateItemType'?: RateItemType;
+    /**
+     *
+     * @type {Currency}
+     * @memberof RateItem
+     */
+    'rateItemCharge'?: Currency;
+    /**
+     * Used for the localization.
+     * @type {string}
+     * @memberof RateItem
+     */
+    'rateItemNameLocalization'?: string;
+}

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

@@ -0,0 +1,110 @@
+/**
+ * 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 { AvailableValueAddedServiceGroup } from './available-value-added-service-group';
+import { Benefits } from './benefits';
+import { Currency } from './currency';
+import { PaymentType } from './payment-type';
+import { Promise } from './promise';
+import { RateItem } from './rate-item';
+import { SupportedDocumentSpecification } from './supported-document-specification';
+import { Weight } from './weight';
+/**
+ * The details of a shipping service offering.
+ * @export
+ * @interface Rate
+ */
+export interface Rate {
+    /**
+     * An identifier for the rate (shipment offering) provided by a shipping service provider.
+     * @type {string}
+     * @memberof Rate
+     */
+    'rateId': string;
+    /**
+     * The carrier identifier for the offering, provided by the carrier.
+     * @type {string}
+     * @memberof Rate
+     */
+    'carrierId': string;
+    /**
+     * The carrier name for the offering.
+     * @type {string}
+     * @memberof Rate
+     */
+    'carrierName': string;
+    /**
+     * An identifier for the shipping service.
+     * @type {string}
+     * @memberof Rate
+     */
+    'serviceId': string;
+    /**
+     * The name of the shipping service.
+     * @type {string}
+     * @memberof Rate
+     */
+    'serviceName': string;
+    /**
+     *
+     * @type {Weight}
+     * @memberof Rate
+     */
+    'billedWeight'?: Weight;
+    /**
+     *
+     * @type {Currency}
+     * @memberof Rate
+     */
+    'totalCharge': Currency;
+    /**
+     *
+     * @type {Promise}
+     * @memberof Rate
+     */
+    'promise': Promise;
+    /**
+     * A list of the document specifications supported for a shipment service offering.
+     * @type {Array<SupportedDocumentSpecification>}
+     * @memberof Rate
+     */
+    'supportedDocumentSpecifications': Array<SupportedDocumentSpecification>;
+    /**
+     * A list of value-added services available for a shipping service offering.
+     * @type {Array<AvailableValueAddedServiceGroup>}
+     * @memberof Rate
+     */
+    'availableValueAddedServiceGroups'?: Array<AvailableValueAddedServiceGroup>;
+    /**
+     * When true, indicates that additional inputs are required to purchase this shipment service. You must then call the getAdditionalInputs operation to return the JSON schema to use when providing the additional inputs to the purchaseShipment operation.
+     * @type {boolean}
+     * @memberof Rate
+     */
+    'requiresAdditionalInputs': boolean;
+    /**
+     * A list of RateItem
+     * @type {Array<RateItem>}
+     * @memberof Rate
+     */
+    'rateItemList'?: Array<RateItem>;
+    /**
+     *
+     * @type {PaymentType}
+     * @memberof Rate
+     */
+    'paymentType'?: PaymentType;
+    /**
+     *
+     * @type {Benefits}
+     * @memberof Rate
+     */
+    'benefits'?: Benefits;
+}