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

package/dist/types/src/api-model/models/benefits.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 { ExcludedBenefit } from './excluded-benefit';
+/**
+ * Representing the included/excluded benefits that we offer for each ShippingOffering/Rate. Benefits being services provided by Amazon when sellers purchase shipping through Amazon.
+ * @export
+ * @interface Benefits
+ */
+export interface Benefits {
+    /**
+     * A list of included benefits.
+     * @type {Array<string>}
+     * @memberof Benefits
+     */
+    'includedBenefits': Array<string>;
+    /**
+     * A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation
+     * @type {Array<ExcludedBenefit>}
+     * @memberof Benefits
+     */
+    'excludedBenefits': Array<ExcludedBenefit>;
+}

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

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ * Response schema for the cancelShipment operation.
+ * @export
+ * @interface CancelShipmentResponse
+ */
+export interface CancelShipmentResponse {
+    /**
+     * The payload for the cancelShipment operation.
+     * @type {{ [key: string]: object; }}
+     * @memberof CancelShipmentResponse
+     */
+    'payload'?: {
+        [key: string]: object;
+    };
+}

package/dist/types/src/api-model/models/carrier-account-attribute.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.
+ */
+/**
+ * Attribute Properties required by carrier
+ * @export
+ * @interface CarrierAccountAttribute
+ */
+export interface CarrierAccountAttribute {
+    /**
+     * Attribute Name .
+     * @type {string}
+     * @memberof CarrierAccountAttribute
+     */
+    'attributeName'?: string;
+    /**
+     * Property Group.
+     * @type {string}
+     * @memberof CarrierAccountAttribute
+     */
+    'propertyGroup'?: string;
+    /**
+     * Value .
+     * @type {string}
+     * @memberof CarrierAccountAttribute
+     */
+    'value'?: string;
+}

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

@@ -0,0 +1,68 @@
+/**
+ * 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 { InputType } from './input-type';
+import { ValidationMetadata } from './validation-metadata';
+/**
+ * Info About CarrierAccountInput
+ * @export
+ * @interface CarrierAccountInput
+ */
+export interface CarrierAccountInput {
+    /**
+     * descriptionLocalizationKey value .
+     * @type {string}
+     * @memberof CarrierAccountInput
+     */
+    'descriptionLocalizationKey'?: string;
+    /**
+     * name value .
+     * @type {string}
+     * @memberof CarrierAccountInput
+     */
+    'name'?: string;
+    /**
+     * groupName value .
+     * @type {string}
+     * @memberof CarrierAccountInput
+     */
+    'groupName'?: string;
+    /**
+     *
+     * @type {InputType}
+     * @memberof CarrierAccountInput
+     */
+    'inputType'?: InputType;
+    /**
+     * mandatory or not  value .
+     * @type {boolean}
+     * @memberof CarrierAccountInput
+     */
+    'isMandatory'?: boolean;
+    /**
+     * is value is Confidential .
+     * @type {boolean}
+     * @memberof CarrierAccountInput
+     */
+    'isConfidential'?: boolean;
+    /**
+     * is value is hidden .
+     * @type {boolean}
+     * @memberof CarrierAccountInput
+     */
+    'isHidden'?: boolean;
+    /**
+     * A list of ValidationMetadata
+     * @type {Array<ValidationMetadata>}
+     * @memberof CarrierAccountInput
+     */
+    'validationMetadata'?: Array<ValidationMetadata>;
+}

package/dist/types/src/api-model/models/carrier.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.
+ */
+/**
+ * Carrier Related Info
+ * @export
+ * @interface Carrier
+ */
+export interface Carrier {
+    /**
+     * The carrier identifier for the offering, provided by the carrier.
+     * @type {string}
+     * @memberof Carrier
+     */
+    'id': string;
+    /**
+     * The carrier name for the offering.
+     * @type {string}
+     * @memberof Carrier
+     */
+    'name': string;
+}

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { AmazonOrderDetails } from './amazon-order-details';
+import { AmazonShipmentDetails } from './amazon-shipment-details';
+import { ChannelType } from './channel-type';
+/**
+ * Shipment source channel related information.
+ * @export
+ * @interface ChannelDetails
+ */
+export interface ChannelDetails {
+    /**
+     *
+     * @type {ChannelType}
+     * @memberof ChannelDetails
+     */
+    'channelType': ChannelType;
+    /**
+     *
+     * @type {AmazonOrderDetails}
+     * @memberof ChannelDetails
+     */
+    'amazonOrderDetails'?: AmazonOrderDetails;
+    /**
+     *
+     * @type {AmazonShipmentDetails}
+     * @memberof ChannelDetails
+     */
+    'amazonShipmentDetails'?: AmazonShipmentDetails;
+}

package/dist/types/src/api-model/models/channel-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.
+ */
+/**
+ * The shipment source channel type.
+ * @export
+ * @enum {string}
+ */
+export declare const ChannelType: {
+    readonly Amazon: "AMAZON";
+    readonly External: "EXTERNAL";
+};
+export type ChannelType = typeof ChannelType[keyof typeof ChannelType];

package/dist/types/src/api-model/models/charge-component.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.
+ */
+import { Currency } from './currency';
+/**
+ * The type and amount of a charge applied on a package.
+ * @export
+ * @interface ChargeComponent
+ */
+export interface ChargeComponent {
+    /**
+     *
+     * @type {Currency}
+     * @memberof ChargeComponent
+     */
+    'amount'?: Currency;
+    /**
+     * The type of charge.
+     * @type {string}
+     * @memberof ChargeComponent
+     */
+    'chargeType'?: ChargeComponentChargeTypeEnum;
+}
+export declare const ChargeComponentChargeTypeEnum: {
+    readonly Tax: "TAX";
+    readonly Discount: "DISCOUNT";
+};
+export type ChargeComponentChargeTypeEnum = typeof ChargeComponentChargeTypeEnum[keyof typeof ChargeComponentChargeTypeEnum];

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

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+/**
+ * Client Reference Details
+ * @export
+ * @interface ClientReferenceDetail
+ */
+export interface ClientReferenceDetail {
+    /**
+     * Client Reference type.
+     * @type {string}
+     * @memberof ClientReferenceDetail
+     */
+    'clientReferenceType': ClientReferenceDetailClientReferenceTypeEnum;
+    /**
+     * The Client Reference Id.
+     * @type {string}
+     * @memberof ClientReferenceDetail
+     */
+    'clientReferenceId': string;
+}
+export declare const ClientReferenceDetailClientReferenceTypeEnum: {
+    readonly IntegratorShipperId: "IntegratorShipperId";
+    readonly IntegratorMerchantId: "IntegratorMerchantId";
+};
+export type ClientReferenceDetailClientReferenceTypeEnum = typeof ClientReferenceDetailClientReferenceTypeEnum[keyof typeof ClientReferenceDetailClientReferenceTypeEnum];

package/dist/types/src/api-model/models/collect-on-delivery.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 { Currency } from './currency';
+/**
+ * The amount to collect on delivery.
+ * @export
+ * @interface CollectOnDelivery
+ */
+export interface CollectOnDelivery {
+    /**
+     *
+     * @type {Currency}
+     * @memberof CollectOnDelivery
+     */
+    'amount': Currency;
+}

package/dist/types/src/api-model/models/collection-forms-history-record.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 { Address } from './address';
+import { GenerationStatus } from './generation-status';
+/**
+ * Active Account Details
+ * @export
+ * @interface CollectionFormsHistoryRecord
+ */
+export interface CollectionFormsHistoryRecord {
+    /**
+     * The carrier name for the offering.
+     * @type {string}
+     * @memberof CollectionFormsHistoryRecord
+     */
+    'carrierName'?: string;
+    /**
+     * Creation Time for this account.
+     * @type {string}
+     * @memberof CollectionFormsHistoryRecord
+     */
+    'creationDate'?: string;
+    /**
+     *
+     * @type {GenerationStatus}
+     * @memberof CollectionFormsHistoryRecord
+     */
+    'generationStatus'?: GenerationStatus;
+    /**
+     * Collection Form Id for Reprint .
+     * @type {string}
+     * @memberof CollectionFormsHistoryRecord
+     */
+    'collectionFormId'?: string;
+    /**
+     *
+     * @type {Address}
+     * @memberof CollectionFormsHistoryRecord
+     */
+    'shipFromAddress'?: Address;
+}

package/dist/types/src/api-model/models/collections-form-document.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.
+ */
+/**
+ * Collection Form Document Details
+ * @export
+ * @interface CollectionsFormDocument
+ */
+export interface CollectionsFormDocument {
+    /**
+     * Base64 document Value of Collection.
+     * @type {string}
+     * @memberof CollectionsFormDocument
+     */
+    'base64EncodedContent'?: string;
+    /**
+     * Collection Document format is PDF.
+     * @type {string}
+     * @memberof CollectionsFormDocument
+     */
+    'documentFormat'?: string;
+}

package/dist/types/src/api-model/models/currency.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 monetary value in the currency indicated, in ISO 4217 standard format.
+ * @export
+ * @interface Currency
+ */
+export interface Currency {
+    /**
+     * The monetary value.
+     * @type {number}
+     * @memberof Currency
+     */
+    'value': number;
+    /**
+     * The ISO 4217 format 3-character currency code.
+     * @type {string}
+     * @memberof Currency
+     */
+    'unit': string;
+}

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

@@ -0,0 +1,64 @@
+/**
+ * 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.
+ */
+/**
+ * Details related to any dangerous goods/items that are being shipped.
+ * @export
+ * @interface DangerousGoodsDetails
+ */
+export interface DangerousGoodsDetails {
+    /**
+     * The specific UNID of the item being shipped.
+     * @type {string}
+     * @memberof DangerousGoodsDetails
+     */
+    'unitedNationsRegulatoryId'?: string;
+    /**
+     * The specific regulatory class  of the item being shipped.
+     * @type {string}
+     * @memberof DangerousGoodsDetails
+     */
+    'transportationRegulatoryClass'?: string;
+    /**
+     * The specific packaging group of the item being shipped.
+     * @type {string}
+     * @memberof DangerousGoodsDetails
+     */
+    'packingGroup'?: DangerousGoodsDetailsPackingGroupEnum;
+    /**
+     * The specific packing instruction of the item being shipped.
+     * @type {string}
+     * @memberof DangerousGoodsDetails
+     */
+    'packingInstruction'?: DangerousGoodsDetailsPackingInstructionEnum;
+}
+export declare const DangerousGoodsDetailsPackingGroupEnum: {
+    readonly I: "I";
+    readonly Ii: "II";
+    readonly Iii: "III";
+};
+export type DangerousGoodsDetailsPackingGroupEnum = typeof DangerousGoodsDetailsPackingGroupEnum[keyof typeof DangerousGoodsDetailsPackingGroupEnum];
+export declare const DangerousGoodsDetailsPackingInstructionEnum: {
+    readonly Pi965SectionIa: "PI965_SECTION_IA";
+    readonly Pi965SectionIb: "PI965_SECTION_IB";
+    readonly Pi965SectionIi: "PI965_SECTION_II";
+    readonly Pi966SectionI: "PI966_SECTION_I";
+    readonly Pi966SectionIi: "PI966_SECTION_II";
+    readonly Pi967SectionI: "PI967_SECTION_I";
+    readonly Pi967SectionIi: "PI967_SECTION_II";
+    readonly Pi968SectionIa: "PI968_SECTION_IA";
+    readonly Pi968SectionIb: "PI968_SECTION_IB";
+    readonly Pi969SectionI: "PI969_SECTION_I";
+    readonly Pi969SectionIi: "PI969_SECTION_II";
+    readonly Pi970SectionI: "PI970_SECTION_I";
+    readonly Pi970SectionIi: "PI970_SECTION_II";
+};
+export type DangerousGoodsDetailsPackingInstructionEnum = typeof DangerousGoodsDetailsPackingInstructionEnum[keyof typeof DangerousGoodsDetailsPackingInstructionEnum];

package/dist/types/src/api-model/models/date-range.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.
+ */
+/**
+ * Date Range for query the results.
+ * @export
+ * @interface DateRange
+ */
+export interface DateRange {
+    /**
+     * Start Date for query .
+     * @type {string}
+     * @memberof DateRange
+     */
+    'startDate'?: string;
+    /**
+     * end date for query.
+     * @type {string}
+     * @memberof DateRange
+     */
+    'endDate'?: string;
+}

package/dist/types/src/api-model/models/dimensions.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.
+ */
+/**
+ * A set of measurements for a three-dimensional object.
+ * @export
+ * @interface Dimensions
+ */
+export interface Dimensions {
+    /**
+     * The length of the package.
+     * @type {number}
+     * @memberof Dimensions
+     */
+    'length': number;
+    /**
+     * The width of the package.
+     * @type {number}
+     * @memberof Dimensions
+     */
+    'width': number;
+    /**
+     * The height of the package.
+     * @type {number}
+     * @memberof Dimensions
+     */
+    'height': number;
+    /**
+     * The unit of measurement.
+     * @type {string}
+     * @memberof Dimensions
+     */
+    'unit': DimensionsUnitEnum;
+}
+export declare const DimensionsUnitEnum: {
+    readonly Inch: "INCH";
+    readonly Centimeter: "CENTIMETER";
+};
+export type DimensionsUnitEnum = typeof DimensionsUnitEnum[keyof typeof DimensionsUnitEnum];

package/dist/types/src/api-model/models/direct-fulfillment-item-identifiers.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.
+ */
+/**
+ * Item identifiers for an item in a direct fulfillment shipment.
+ * @export
+ * @interface DirectFulfillmentItemIdentifiers
+ */
+export interface DirectFulfillmentItemIdentifiers {
+    /**
+     * A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated for direct fulfillment multi-piece shipments. It is required if a vendor wants to change the configuration of the packages in which the purchase order is shipped.
+     * @type {string}
+     * @memberof DirectFulfillmentItemIdentifiers
+     */
+    'lineItemID': string;
+    /**
+     * A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated if a single line item has multiple pieces. Defaults to 1.
+     * @type {string}
+     * @memberof DirectFulfillmentItemIdentifiers
+     */
+    'pieceNumber'?: string;
+}