@sp-api-sdk/amazon-warehousing-and-distribution-api-2024-05-09 2.0.0

package/dist/types/api-model/models/carrier-code-type.d.ts

@@ -0,0 +1,20 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Denotes the type for the carrier.
+ * @export
+ * @enum {string}
+ */
+export declare const CarrierCodeType: {
+    readonly Scac: "SCAC";
+};
+export type CarrierCodeType = typeof CarrierCodeType[keyof typeof CarrierCodeType];

package/dist/types/api-model/models/carrier-code.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CarrierCodeType } from './carrier-code-type';
+/**
+ * Identifies the carrier that will deliver the shipment.
+ * @export
+ * @interface CarrierCode
+ */
+export interface CarrierCode {
+    /**
+     *
+     * @type {CarrierCodeType}
+     * @memberof CarrierCode
+     */
+    'carrierCodeType'?: CarrierCodeType;
+    /**
+     * Value of the carrier code.
+     * @type {string}
+     * @memberof CarrierCode
+     */
+    'carrierCodeValue'?: string;
+}

package/dist/types/api-model/models/dimension-unit-of-measurement.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Unit of measurement for package dimensions.
+ * @export
+ * @enum {string}
+ */
+export declare const DimensionUnitOfMeasurement: {
+    readonly Inches: "INCHES";
+    readonly Centimeters: "CENTIMETERS";
+};
+export type DimensionUnitOfMeasurement = typeof DimensionUnitOfMeasurement[keyof typeof DimensionUnitOfMeasurement];

package/dist/types/api-model/models/distribution-package-contents.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DistributionPackageQuantity } from './distribution-package-quantity';
+import type { ProductQuantity } from './product-quantity';
+/**
+ * Represents the contents inside a package, which can be products or a nested package.
+ * @export
+ * @interface DistributionPackageContents
+ */
+export interface DistributionPackageContents {
+    /**
+     * This is required only when `DistributionPackageType=PALLET`.
+     * @type {Array<DistributionPackageQuantity>}
+     * @memberof DistributionPackageContents
+     */
+    'packages'?: Array<DistributionPackageQuantity>;
+    /**
+     * This is required only when `DistributionPackageType=CASE`.
+     * @type {Array<ProductQuantity>}
+     * @memberof DistributionPackageContents
+     */
+    'products'?: Array<ProductQuantity>;
+}

package/dist/types/api-model/models/distribution-package-quantity.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DistributionPackage } from './distribution-package';
+/**
+ * Represents a distribution package with its respective quantity.
+ * @export
+ * @interface DistributionPackageQuantity
+ */
+export interface DistributionPackageQuantity {
+    /**
+     * Number of cases or pallets with the same package configuration.
+     * @type {number}
+     * @memberof DistributionPackageQuantity
+     */
+    'count': number;
+    /**
+     *
+     * @type {DistributionPackage}
+     * @memberof DistributionPackageQuantity
+     */
+    'distributionPackage': DistributionPackage;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * 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 distribution packages.
+ * @export
+ * @enum {string}
+ */
+export declare const DistributionPackageType: {
+    readonly Case: "CASE";
+    readonly Pallet: "PALLET";
+};
+export type DistributionPackageType = typeof DistributionPackageType[keyof typeof DistributionPackageType];

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

@@ -0,0 +1,39 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DistributionPackageContents } from './distribution-package-contents';
+import type { DistributionPackageType } from './distribution-package-type';
+import type { MeasurementData } from './measurement-data';
+/**
+ * Represents an AWD distribution package.
+ * @export
+ * @interface DistributionPackage
+ */
+export interface DistributionPackage {
+    /**
+     *
+     * @type {DistributionPackageContents}
+     * @memberof DistributionPackage
+     */
+    'contents': DistributionPackageContents;
+    /**
+     *
+     * @type {MeasurementData}
+     * @memberof DistributionPackage
+     */
+    'measurements': MeasurementData;
+    /**
+     *
+     * @type {DistributionPackageType}
+     * @memberof DistributionPackage
+     */
+    'type': DistributionPackageType;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * This exception is thrown when client inputs are invalid.
+ * @export
+ * @interface ErrorList
+ */
+export interface ErrorList {
+    /**
+     * A list of errors describing the failures.
+     * @type {Array<Error>}
+     * @memberof ErrorList
+     */
+    'errors': Array<Error>;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The expiration details of the inventory. This object will only appear if the details parameter in the request is set to `SHOW`.
+ * @export
+ * @interface ExpirationDetails
+ */
+export interface ExpirationDetails {
+    /**
+     * The expiration date of the SKU.
+     * @type {string}
+     * @memberof ExpirationDetails
+     */
+    'expiration'?: string;
+    /**
+     * The quantity that is present in AWD.
+     * @type {number}
+     * @memberof ExpirationDetails
+     */
+    'onhandQuantity'?: number;
+}

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

@@ -0,0 +1,20 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The label format type extension.
+ * @export
+ * @enum {string}
+ */
+export declare const FormatType: {
+    readonly Pdf: "PDF";
+};
+export type FormatType = typeof FormatType[keyof typeof FormatType];

package/dist/types/api-model/models/inbound-eligibility-status.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Enum denoting the package inbound eligibility.
+ * @export
+ * @enum {string}
+ */
+export declare const InboundEligibilityStatus: {
+    readonly Eligible: "ELIGIBLE";
+    readonly Ineligible: "INELIGIBLE";
+};
+export type InboundEligibilityStatus = typeof InboundEligibilityStatus[keyof typeof InboundEligibilityStatus];

package/dist/types/api-model/models/inbound-eligibility.d.ts

@@ -0,0 +1,45 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { InboundEligibilityStatus } from './inbound-eligibility-status';
+import type { OrderIneligibilityReason } from './order-ineligibility-reason';
+import type { SkuEligibility } from './sku-eligibility';
+/**
+ * Represents the eligibility status of the inbound packages.
+ * @export
+ * @interface InboundEligibility
+ */
+export interface InboundEligibility {
+    /**
+     * If there are order level eligibility issues, then this list will contain those error codes and descriptions.
+     * @type {Array<OrderIneligibilityReason>}
+     * @memberof InboundEligibility
+     */
+    'ineligibilityReasons'?: Array<OrderIneligibilityReason>;
+    /**
+     * Details on SKU eligibility for each inbound package.
+     * @type {Array<SkuEligibility>}
+     * @memberof InboundEligibility
+     */
+    'packagesToInbound': Array<SkuEligibility>;
+    /**
+     * Timestamp when the eligibility check is performed.
+     * @type {string}
+     * @memberof InboundEligibility
+     */
+    'previewedAt': string;
+    /**
+     *
+     * @type {InboundEligibilityStatus}
+     * @memberof InboundEligibility
+     */
+    'status': InboundEligibilityStatus;
+}

package/dist/types/api-model/models/inbound-order-creation-data.d.ts

@@ -0,0 +1,51 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Address } from './address';
+import type { DistributionPackageQuantity } from './distribution-package-quantity';
+import type { InboundPreferences } from './inbound-preferences';
+/**
+ * Payload for creating an inbound order.
+ * @export
+ * @interface InboundOrderCreationData
+ */
+export interface InboundOrderCreationData {
+    /**
+     * Reference ID that can be used to correlate the order with partner resources.
+     * @type {string}
+     * @memberof InboundOrderCreationData
+     */
+    'externalReferenceId'?: string;
+    /**
+     *
+     * @type {Address}
+     * @memberof InboundOrderCreationData
+     */
+    'originAddress': Address;
+    /**
+     * List of packages to be inbounded.
+     * @type {Array<DistributionPackageQuantity>}
+     * @memberof InboundOrderCreationData
+     */
+    'packagesToInbound': Array<DistributionPackageQuantity>;
+    /**
+     *
+     * @type {InboundPreferences}
+     * @memberof InboundOrderCreationData
+     */
+    'preferences'?: InboundPreferences;
+    /**
+     * Estimated date by when goods have to be picked up.
+     * @type {string}
+     * @memberof InboundOrderCreationData
+     */
+    'shipBy'?: string;
+}

package/dist/types/api-model/models/inbound-order-reference.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A response that contains the reference identifiers for the newly created or updated inbound order. Consists of an order ID and version.
+ * @export
+ * @interface InboundOrderReference
+ */
+export interface InboundOrderReference {
+    /**
+     * Order ID of the inbound order.
+     * @type {string}
+     * @memberof InboundOrderReference
+     */
+    'orderId': string;
+    /**
+     * Order version of the inbound order.
+     * @type {string}
+     * @memberof InboundOrderReference
+     */
+    'orderVersion': string;
+}

package/dist/types/api-model/models/inbound-order.d.ts

@@ -0,0 +1,89 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Address } from './address';
+import type { DistributionPackageQuantity } from './distribution-package-quantity';
+import type { InboundPreferences } from './inbound-preferences';
+import type { InboundShipment } from './inbound-shipment';
+import type { InboundStatus } from './inbound-status';
+/**
+ * Represents an AWD inbound order.
+ * @export
+ * @interface InboundOrder
+ */
+export interface InboundOrder {
+    /**
+     * List of inbound shipments part of this order.
+     * @type {Array<InboundShipment>}
+     * @memberof InboundOrder
+     */
+    'channelPlacedInboundShipments': Array<InboundShipment>;
+    /**
+     * Date when this order was created.
+     * @type {string}
+     * @memberof InboundOrder
+     */
+    'createdAt': string;
+    /**
+     * Reference ID that can be used to correlate the order with partner resources.
+     * @type {string}
+     * @memberof InboundOrder
+     */
+    'externalReferenceId'?: string;
+    /**
+     * Inbound order ID.
+     * @type {string}
+     * @memberof InboundOrder
+     */
+    'orderId': string;
+    /**
+     *
+     * @type {InboundStatus}
+     * @memberof InboundOrder
+     */
+    'orderStatus': InboundStatus;
+    /**
+     * Inbound order version.
+     * @type {string}
+     * @memberof InboundOrder
+     */
+    'orderVersion': string;
+    /**
+     *
+     * @type {Address}
+     * @memberof InboundOrder
+     */
+    'originAddress': Address;
+    /**
+     * List of packages to be inbounded.
+     * @type {Array<DistributionPackageQuantity>}
+     * @memberof InboundOrder
+     */
+    'packagesToInbound': Array<DistributionPackageQuantity>;
+    /**
+     *
+     * @type {InboundPreferences}
+     * @memberof InboundOrder
+     */
+    'preferences'?: InboundPreferences;
+    /**
+     * Date by which this order will be shipped.
+     * @type {string}
+     * @memberof InboundOrder
+     */
+    'shipBy'?: string;
+    /**
+     * Date when this order was last updated.
+     * @type {string}
+     * @memberof InboundOrder
+     */
+    'updatedAt'?: string;
+}

package/dist/types/api-model/models/inbound-packages.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DistributionPackageQuantity } from './distribution-package-quantity';
+/**
+ * Represents the packages to inbound.
+ * @export
+ * @interface InboundPackages
+ */
+export interface InboundPackages {
+    /**
+     * List of packages to be inbounded.
+     * @type {Array<DistributionPackageQuantity>}
+     * @memberof InboundPackages
+     */
+    'packagesToInbound': Array<DistributionPackageQuantity>;
+}

package/dist/types/api-model/models/inbound-preferences.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Preferences that can be passed in context of an inbound order
+ * @export
+ * @interface InboundPreferences
+ */
+export interface InboundPreferences {
+    /**
+     * Pass a preferred region so that the inbound order can be shipped to an AWD warehouse located in that region. This doesn\'t guarantee the order to be assigned in the specified destination region as it depends on warehouse capacity availability. AWD currently supports following region IDs: [us-west, us-east]
+     * @type {string}
+     * @memberof InboundPreferences
+     */
+    'destinationRegion'?: string;
+}

package/dist/types/api-model/models/inbound-shipment-status.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Possible shipment statuses used by shipments.
+ * @export
+ * @enum {string}
+ */
+export declare const InboundShipmentStatus: {
+    readonly Created: "CREATED";
+    readonly Shipped: "SHIPPED";
+    readonly InTransit: "IN_TRANSIT";
+    readonly Receiving: "RECEIVING";
+    readonly Delivered: "DELIVERED";
+    readonly Closed: "CLOSED";
+    readonly Cancelled: "CANCELLED";
+};
+export type InboundShipmentStatus = typeof InboundShipmentStatus[keyof typeof InboundShipmentStatus];

package/dist/types/api-model/models/inbound-shipment-summary.d.ts

@@ -0,0 +1,55 @@
+/**
+ * The Selling Partner API for Amazon Warehousing and Distribution
+ * The Selling Partner API for Amazon Warehousing and Distribution (AWD) provides programmatic access to information about AWD shipments and inventory.
+ *
+ * The version of the OpenAPI document: 2024-05-09
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { InboundShipmentStatus } from './inbound-shipment-status';
+/**
+ * Summary for an AWD inbound shipment containing the shipment ID, which can be used to retrieve the actual shipment.
+ * @export
+ * @interface InboundShipmentSummary
+ */
+export interface InboundShipmentSummary {
+    /**
+     * Timestamp when the shipment was created.
+     * @type {string}
+     * @memberof InboundShipmentSummary
+     */
+    'createdAt'?: string;
+    /**
+     * Optional client-provided reference ID that can be used to correlate this shipment with client resources. For example, to map this shipment to an internal bookkeeping order record.
+     * @type {string}
+     * @memberof InboundShipmentSummary
+     */
+    'externalReferenceId'?: string;
+    /**
+     * The AWD inbound order ID that this inbound shipment belongs to.
+     * @type {string}
+     * @memberof InboundShipmentSummary
+     */
+    'orderId': string;
+    /**
+     * A unique shipment ID.
+     * @type {string}
+     * @memberof InboundShipmentSummary
+     */
+    'shipmentId': string;
+    /**
+     *
+     * @type {InboundShipmentStatus}
+     * @memberof InboundShipmentSummary
+     */
+    'shipmentStatus': InboundShipmentStatus;
+    /**
+     * Timestamp when the shipment was updated.
+     * @type {string}
+     * @memberof InboundShipmentSummary
+     */
+    'updatedAt'?: string;
+}