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

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

@@ -0,0 +1,49 @@
+/**
+ * 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 { IneligibilityReason } from './ineligibility-reason';
+/**
+ * Detailed information for an ineligible shipping service offering.
+ * @export
+ * @interface IneligibleRate
+ */
+export interface IneligibleRate {
+    /**
+     * An identifier for the shipping service.
+     * @type {string}
+     * @memberof IneligibleRate
+     */
+    'serviceId': string;
+    /**
+     * The name of the shipping service.
+     * @type {string}
+     * @memberof IneligibleRate
+     */
+    'serviceName': string;
+    /**
+     * The carrier name for the offering.
+     * @type {string}
+     * @memberof IneligibleRate
+     */
+    'carrierName': string;
+    /**
+     * The carrier identifier for the offering, provided by the carrier.
+     * @type {string}
+     * @memberof IneligibleRate
+     */
+    'carrierId': string;
+    /**
+     * A list of reasons why a shipping service offering is ineligible.
+     * @type {Array<IneligibilityReason>}
+     * @memberof IneligibleRate
+     */
+    'ineligibilityReasons': Array<IneligibilityReason>;
+}

package/dist/types/src/api-model/models/input-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.
+ */
+/**
+ * Type of Input.
+ * @export
+ * @enum {string}
+ */
+export declare const InputType: {
+    readonly Textbox: "TEXTBOX";
+    readonly Password: "PASSWORD";
+};
+export type InputType = typeof InputType[keyof typeof InputType];

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

@@ -0,0 +1,30 @@
+/**
+ * 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.
+ */
+/**
+ * The invoice details for charges associated with the goods in the package. Only applies to certain regions.
+ * @export
+ * @interface InvoiceDetails
+ */
+export interface InvoiceDetails {
+    /**
+     * The invoice number of the item.
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    'invoiceNumber'?: string;
+    /**
+     * The invoice date of the item in ISO 8061 format.
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    'invoiceDate'?: string;
+}

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

@@ -0,0 +1,96 @@
+/**
+ * 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 { DangerousGoodsDetails } from './dangerous-goods-details';
+import { DirectFulfillmentItemIdentifiers } from './direct-fulfillment-item-identifiers';
+import { InvoiceDetails } from './invoice-details';
+import { LiquidVolume } from './liquid-volume';
+import { Weight } from './weight';
+/**
+ * An item in a package.
+ * @export
+ * @interface Item
+ */
+export interface Item {
+    /**
+     *
+     * @type {Currency}
+     * @memberof Item
+     */
+    'itemValue'?: Currency;
+    /**
+     * The product description of the item.
+     * @type {string}
+     * @memberof Item
+     */
+    'description'?: string;
+    /**
+     * A unique identifier for an item provided by the client.
+     * @type {string}
+     * @memberof Item
+     */
+    'itemIdentifier'?: string;
+    /**
+     * The number of units. This value is required.
+     * @type {number}
+     * @memberof Item
+     */
+    'quantity': number;
+    /**
+     *
+     * @type {Weight}
+     * @memberof Item
+     */
+    'weight'?: Weight;
+    /**
+     *
+     * @type {LiquidVolume}
+     * @memberof Item
+     */
+    'liquidVolume'?: LiquidVolume;
+    /**
+     * When true, the item qualifies as hazardous materials (hazmat). Defaults to false.
+     * @type {boolean}
+     * @memberof Item
+     */
+    'isHazmat'?: boolean;
+    /**
+     *
+     * @type {DangerousGoodsDetails}
+     * @memberof Item
+     */
+    'dangerousGoodsDetails'?: DangerousGoodsDetails;
+    /**
+     * The product type of the item.
+     * @type {string}
+     * @memberof Item
+     */
+    'productType'?: string;
+    /**
+     *
+     * @type {InvoiceDetails}
+     * @memberof Item
+     */
+    'invoiceDetails'?: InvoiceDetails;
+    /**
+     * A list of unique serial numbers in an Amazon package that can be used to guarantee non-fraudulent items. The number of serial numbers in the list must be less than or equal to the quantity of items being shipped. Only applicable when channel source is Amazon.
+     * @type {Array<string>}
+     * @memberof Item
+     */
+    'serialNumbers'?: Array<string>;
+    /**
+     *
+     * @type {DirectFulfillmentItemIdentifiers}
+     * @memberof Item
+     */
+    'directFulfillmentItemIdentifiers'?: DirectFulfillmentItemIdentifiers;
+}

package/dist/types/src/api-model/models/link-carrier-account-request.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { CarrierAccountAttribute } from './carrier-account-attribute';
+import { ClientReferenceDetail } from './client-reference-detail';
+/**
+ * The request schema for verify and add the merchant\'s account with a certain carrier.
+ * @export
+ * @interface LinkCarrierAccountRequest
+ */
+export interface LinkCarrierAccountRequest {
+    /**
+     * Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail
+     * @type {Array<ClientReferenceDetail>}
+     * @memberof LinkCarrierAccountRequest
+     */
+    'clientReferenceDetails'?: Array<ClientReferenceDetail>;
+    /**
+     * CarrierAccountType  associated with account.
+     * @type {string}
+     * @memberof LinkCarrierAccountRequest
+     */
+    'carrierAccountType': string;
+    /**
+     * A list of all attributes required by the carrier in order to successfully link the merchant\'s account
+     * @type {Array<CarrierAccountAttribute>}
+     * @memberof LinkCarrierAccountRequest
+     */
+    'carrierAccountAttributes': Array<CarrierAccountAttribute>;
+    /**
+     * A list of all attributes required by the carrier in order to successfully link the merchant\'s account
+     * @type {Array<CarrierAccountAttribute>}
+     * @memberof LinkCarrierAccountRequest
+     */
+    'encryptedCarrierAccountAttributes'?: Array<CarrierAccountAttribute>;
+}

package/dist/types/src/api-model/models/link-carrier-account-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 { AccountStatus } from './account-status';
+/**
+ * The Response  for the LinkCarrierAccount operation.
+ * @export
+ * @interface LinkCarrierAccountResponse
+ */
+export interface LinkCarrierAccountResponse {
+    /**
+     *
+     * @type {AccountStatus}
+     * @memberof LinkCarrierAccountResponse
+     */
+    'registrationStatus'?: AccountStatus;
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 { AccountType } from './account-type';
+import { CarrierAccountInput } from './carrier-account-input';
+/**
+ * Info About Linkable Account Type
+ * @export
+ * @interface LinkableAccountType
+ */
+export interface LinkableAccountType {
+    /**
+     *
+     * @type {AccountType}
+     * @memberof LinkableAccountType
+     */
+    'accountType'?: AccountType;
+    /**
+     * A list of CarrierAccountInput
+     * @type {Array<CarrierAccountInput>}
+     * @memberof LinkableAccountType
+     */
+    'carrierAccountInputs'?: Array<CarrierAccountInput>;
+}

package/dist/types/src/api-model/models/linkable-carrier.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 { LinkableAccountType } from './linkable-account-type';
+/**
+ * Info About Linkable Carrier
+ * @export
+ * @interface LinkableCarrier
+ */
+export interface LinkableCarrier {
+    /**
+     * The carrier identifier for the offering, provided by the carrier.
+     * @type {string}
+     * @memberof LinkableCarrier
+     */
+    'carrierId'?: string;
+    /**
+     * A list of LinkableAccountType
+     * @type {Array<LinkableAccountType>}
+     * @memberof LinkableCarrier
+     */
+    'linkableAccountTypes'?: Array<LinkableAccountType>;
+}

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

@@ -0,0 +1,40 @@
+/**
+ * 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.
+ */
+/**
+ * Liquid Volume.
+ * @export
+ * @interface LiquidVolume
+ */
+export interface LiquidVolume {
+    /**
+     * The unit of measurement.
+     * @type {string}
+     * @memberof LiquidVolume
+     */
+    'unit': LiquidVolumeUnitEnum;
+    /**
+     * The measurement value.
+     * @type {number}
+     * @memberof LiquidVolume
+     */
+    'value': number;
+}
+export declare const LiquidVolumeUnitEnum: {
+    readonly Ml: "ML";
+    readonly L: "L";
+    readonly FlOz: "FL_OZ";
+    readonly Gal: "GAL";
+    readonly Pt: "PT";
+    readonly Qt: "QT";
+    readonly C: "C";
+};
+export type LiquidVolumeUnitEnum = typeof LiquidVolumeUnitEnum[keyof typeof LiquidVolumeUnitEnum];

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

@@ -0,0 +1,42 @@
+/**
+ * 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.
+ */
+/**
+ * The location where the person, business or institution is located.
+ * @export
+ * @interface Location
+ */
+export interface Location {
+    /**
+     * The state, county or region where the person, business or institution is located.
+     * @type {string}
+     * @memberof Location
+     */
+    'stateOrRegion'?: string;
+    /**
+     * The city or town where the person, business or institution is located.
+     * @type {string}
+     * @memberof Location
+     */
+    'city'?: string;
+    /**
+     * The two digit country code. Follows ISO 3166-1 alpha-2 format.
+     * @type {string}
+     * @memberof Location
+     */
+    'countryCode'?: string;
+    /**
+     * The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
+     * @type {string}
+     * @memberof Location
+     */
+    'postalCode'?: string;
+}

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

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+/**
+ * Error response returned when the request is unsuccessful.
+ * @export
+ * @interface ModelError
+ */
+export interface ModelError {
+    /**
+     * An error code that identifies the type of error that occurred.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'code': string;
+    /**
+     * A message that describes the error condition.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'message': string;
+    /**
+     * Additional details that can help the caller understand or fix the issue.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'details'?: string;
+}

package/dist/types/src/api-model/models/one-click-shipment-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 { OneClickShipmentValueAddedService } from './one-click-shipment-value-added-service';
+import { Package } from './package';
+import { RequestedDocumentSpecification } from './requested-document-specification';
+import { ServiceSelection } from './service-selection';
+import { ShipperInstruction } from './shipper-instruction';
+import { TaxDetail } from './tax-detail';
+/**
+ * The request schema for the OneClickShipment operation. When the channelType is not Amazon, shipTo is required and when channelType is Amazon shipTo is ignored.
+ * @export
+ * @interface OneClickShipmentRequest
+ */
+export interface OneClickShipmentRequest {
+    /**
+     *
+     * @type {Address}
+     * @memberof OneClickShipmentRequest
+     */
+    'shipTo'?: Address;
+    /**
+     *
+     * @type {Address}
+     * @memberof OneClickShipmentRequest
+     */
+    'shipFrom': Address;
+    /**
+     *
+     * @type {Address}
+     * @memberof OneClickShipmentRequest
+     */
+    'returnTo'?: Address;
+    /**
+     * The ship date and time (the requested pickup). This defaults to the current date and time.
+     * @type {string}
+     * @memberof OneClickShipmentRequest
+     */
+    'shipDate'?: string;
+    /**
+     * A list of packages to be shipped through a shipping service offering.
+     * @type {Array<Package>}
+     * @memberof OneClickShipmentRequest
+     */
+    'packages': Array<Package>;
+    /**
+     * The value-added services to be added to a shipping service purchase.
+     * @type {Array<OneClickShipmentValueAddedService>}
+     * @memberof OneClickShipmentRequest
+     */
+    'valueAddedServicesDetails'?: Array<OneClickShipmentValueAddedService>;
+    /**
+     * A list of tax detail information.
+     * @type {Array<TaxDetail>}
+     * @memberof OneClickShipmentRequest
+     */
+    'taxDetails'?: Array<TaxDetail>;
+    /**
+     *
+     * @type {ChannelDetails}
+     * @memberof OneClickShipmentRequest
+     */
+    'channelDetails': ChannelDetails;
+    /**
+     *
+     * @type {RequestedDocumentSpecification}
+     * @memberof OneClickShipmentRequest
+     */
+    'labelSpecifications': RequestedDocumentSpecification;
+    /**
+     *
+     * @type {ServiceSelection}
+     * @memberof OneClickShipmentRequest
+     */
+    'serviceSelection': ServiceSelection;
+    /**
+     *
+     * @type {ShipperInstruction}
+     * @memberof OneClickShipmentRequest
+     */
+    'shipperInstruction'?: ShipperInstruction;
+    /**
+     *
+     * @type {AccessPointDetails}
+     * @memberof OneClickShipmentRequest
+     */
+    'destinationAccessPointDetails'?: AccessPointDetails;
+}

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

package/dist/types/src/api-model/models/one-click-shipment-result.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 { Carrier } from './carrier';
+import { Currency } from './currency';
+import { PackageDocumentDetail } from './package-document-detail';
+import { Promise } from './promise';
+import { Service } from './service';
+/**
+ * The payload for the OneClickShipment API.
+ * @export
+ * @interface OneClickShipmentResult
+ */
+export interface OneClickShipmentResult {
+    /**
+     * The unique shipment identifier provided by a shipping service.
+     * @type {string}
+     * @memberof OneClickShipmentResult
+     */
+    'shipmentId': string;
+    /**
+     * A list of post-purchase details about a package that will be shipped using a shipping service.
+     * @type {Array<PackageDocumentDetail>}
+     * @memberof OneClickShipmentResult
+     */
+    'packageDocumentDetails': Array<PackageDocumentDetail>;
+    /**
+     *
+     * @type {Promise}
+     * @memberof OneClickShipmentResult
+     */
+    'promise': Promise;
+    /**
+     *
+     * @type {Carrier}
+     * @memberof OneClickShipmentResult
+     */
+    'carrier': Carrier;
+    /**
+     *
+     * @type {Service}
+     * @memberof OneClickShipmentResult
+     */
+    'service': Service;
+    /**
+     *
+     * @type {Currency}
+     * @memberof OneClickShipmentResult
+     */
+    'totalCharge': Currency;
+}

package/dist/types/src/api-model/models/one-click-shipment-value-added-service.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 { Currency } from './currency';
+/**
+ * A value-added service to be applied to a shipping service purchase.
+ * @export
+ * @interface OneClickShipmentValueAddedService
+ */
+export interface OneClickShipmentValueAddedService {
+    /**
+     * The identifier of the selected value-added service.
+     * @type {string}
+     * @memberof OneClickShipmentValueAddedService
+     */
+    'id': string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof OneClickShipmentValueAddedService
+     */
+    'amount'?: Currency;
+}