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

package/dist/types/api-model/models/outbound-listing.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 { OutboundOrder } from './outbound-order';
+/**
+ * A list of paginated outbound orders filtered by the attributes passed in the request.
+ * @export
+ * @interface OutboundListing
+ */
+export interface OutboundListing {
+    /**
+     * TA token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
+     * @type {string}
+     * @memberof OutboundListing
+     */
+    'nextToken'?: string;
+    /**
+     * List of outbound orders.
+     * @type {Array<OutboundOrder>}
+     * @memberof OutboundListing
+     */
+    'outboundOrders'?: Array<OutboundOrder>;
+}

package/dist/types/api-model/models/outbound-order-creation-data.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 { DistributionPackageQuantity } from './distribution-package-quantity';
+import type { OrderAttribute } from './order-attribute';
+import type { ProductQuantity } from './product-quantity';
+/**
+ * Payload for creating an outbound order.
+ * @export
+ * @interface OutboundOrderCreationData
+ */
+export interface OutboundOrderCreationData {
+    /**
+     * Order preferences for the outbound order.
+     * @type {Array<OrderAttribute>}
+     * @memberof OutboundOrderCreationData
+     */
+    'orderPreferences'?: Array<OrderAttribute>;
+    /**
+     * List of packages to be outbound.
+     * @type {Array<DistributionPackageQuantity>}
+     * @memberof OutboundOrderCreationData
+     */
+    'packagesToOutbound'?: Array<DistributionPackageQuantity>;
+    /**
+     * List of product units to be outbound.
+     * @type {Array<ProductQuantity>}
+     * @memberof OutboundOrderCreationData
+     */
+    'productsToOutbound'?: Array<ProductQuantity>;
+}

package/dist/types/api-model/models/outbound-order-reference.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.
+ */
+/**
+ * A response that contains the reference identifier for the newly created or updated outbound order. This includes an order ID.
+ * @export
+ * @interface OutboundOrderReference
+ */
+export interface OutboundOrderReference {
+    /**
+     * outbound order ID.
+     * @type {string}
+     * @memberof OutboundOrderReference
+     */
+    'orderId': string;
+}

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

@@ -0,0 +1,108 @@
+/**
+ * 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 { OrderAttribute } from './order-attribute';
+import type { OutboundExecutionError } from './outbound-execution-error';
+import type { OutboundShipment } from './outbound-shipment';
+import type { OutboundStatus } from './outbound-status';
+import type { ProductQuantity } from './product-quantity';
+/**
+ * Represents an AWD outbound order.
+ * @export
+ * @interface OutboundOrder
+ */
+export interface OutboundOrder {
+    /**
+     * Date on which this outbound order was confirmed.
+     * @type {string}
+     * @memberof OutboundOrder
+     */
+    'confirmedOn'?: string;
+    /**
+     * Date on which this outbound order was created.
+     * @type {string}
+     * @memberof OutboundOrder
+     */
+    'createdAt'?: string;
+    /**
+     * List of packages that are eligible for outbound.
+     * @type {Array<DistributionPackageQuantity>}
+     * @memberof OutboundOrder
+     */
+    'eligiblePackagesToOutbound'?: Array<DistributionPackageQuantity>;
+    /**
+     * List of product units that are eligible for outbound.
+     * @type {Array<ProductQuantity>}
+     * @memberof OutboundOrder
+     */
+    'eligibleProductsToOutbound'?: Array<ProductQuantity>;
+    /**
+     * Execution errors associated with the outbound order. This field will be populated if the order failed validation.
+     * @type {Array<OutboundExecutionError>}
+     * @memberof OutboundOrder
+     */
+    'executionErrors'?: Array<OutboundExecutionError>;
+    /**
+     * Order ID for the outbound order.
+     * @type {string}
+     * @memberof OutboundOrder
+     */
+    'orderId': string;
+    /**
+     * Order preferences for this outbound order.
+     * @type {Array<OrderAttribute>}
+     * @memberof OutboundOrder
+     */
+    'orderPreferences'?: Array<OrderAttribute>;
+    /**
+     *
+     * @type {OutboundStatus}
+     * @memberof OutboundOrder
+     */
+    'orderStatus': OutboundStatus;
+    /**
+     * List of outbound shipments that are part of this order.
+     * @type {Array<OutboundShipment>}
+     * @memberof OutboundOrder
+     */
+    'outboundShipments': Array<OutboundShipment>;
+    /**
+     * List of packages to be outbound.
+     * @type {Array<DistributionPackageQuantity>}
+     * @memberof OutboundOrder
+     */
+    'packagesToOutbound'?: Array<DistributionPackageQuantity>;
+    /**
+     * List of product units to be outbound.
+     * @type {Array<ProductQuantity>}
+     * @memberof OutboundOrder
+     */
+    'productsToOutbound'?: Array<ProductQuantity>;
+    /**
+     * Outbound packages that are shipped after the execution has completed post confirmation.
+     * @type {Array<DistributionPackageQuantity>}
+     * @memberof OutboundOrder
+     */
+    'shippedOutboundPackages'?: Array<DistributionPackageQuantity>;
+    /**
+     * Outbound product units that are shipped after the execution has completed post confirmation.
+     * @type {Array<ProductQuantity>}
+     * @memberof OutboundOrder
+     */
+    'shippedOutboundProducts'?: Array<ProductQuantity>;
+    /**
+     * Date on which this outbound order was last updated.
+     * @type {string}
+     * @memberof OutboundOrder
+     */
+    'updatedAt'?: string;
+}

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

@@ -0,0 +1,27 @@
+/**
+ * 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 for outbound shipments.
+ * @export
+ * @enum {string}
+ */
+export declare const OutboundShipmentStatus: {
+    readonly Created: "CREATED";
+    readonly InTransit: "IN_TRANSIT";
+    readonly Delivered: "DELIVERED";
+    readonly Receiving: "RECEIVING";
+    readonly Received: "RECEIVED";
+    readonly Closed: "CLOSED";
+    readonly Cancelled: "CANCELLED";
+    readonly Failed: "FAILED";
+};
+export type OutboundShipmentStatus = typeof OutboundShipmentStatus[keyof typeof OutboundShipmentStatus];

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

@@ -0,0 +1,76 @@
+/**
+ * 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 { OutboundShipmentStatus } from './outbound-shipment-status';
+import type { ProductQuantity } from './product-quantity';
+/**
+ * Represents an AWD outbound shipment.
+ * @export
+ * @interface OutboundShipment
+ */
+export interface OutboundShipment {
+    /**
+     * Timestamp when the shipment was created.
+     * @type {string}
+     * @memberof OutboundShipment
+     */
+    'createdAt'?: string;
+    /**
+     *
+     * @type {Address}
+     * @memberof OutboundShipment
+     */
+    'destinationAddress': Address;
+    /**
+     * Outbound order ID this outbound shipment belongs to.
+     * @type {string}
+     * @memberof OutboundShipment
+     */
+    'orderId': string;
+    /**
+     *
+     * @type {Address}
+     * @memberof OutboundShipment
+     */
+    'originAddress': Address;
+    /**
+     * Specific distribution packages that are included in the context of this shipment.
+     * @type {Array<DistributionPackageQuantity>}
+     * @memberof OutboundShipment
+     */
+    'shipmentPackageQuantities'?: Array<DistributionPackageQuantity>;
+    /**
+     * Unique shipment ID.
+     * @type {string}
+     * @memberof OutboundShipment
+     */
+    'shipmentId': string;
+    /**
+     * Specific product units that are included in the context of this shipment.
+     * @type {Array<ProductQuantity>}
+     * @memberof OutboundShipment
+     */
+    'shipmentProductQuantities'?: Array<ProductQuantity>;
+    /**
+     *
+     * @type {OutboundShipmentStatus}
+     * @memberof OutboundShipment
+     */
+    'shipmentStatus': OutboundShipmentStatus;
+    /**
+     * Timestamp when the shipment was updated.
+     * @type {string}
+     * @memberof OutboundShipment
+     */
+    'updatedAt'?: string;
+}

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

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+/**
+ * Statuses supported for an outbound order.
+ * @export
+ * @enum {string}
+ */
+export declare const OutboundStatus: {
+    readonly Confirmed: "CONFIRMED";
+    readonly Draft: "DRAFT";
+    readonly Eligible: "ELIGIBLE";
+    readonly Executing: "EXECUTING";
+    readonly Failure: "FAILURE";
+    readonly Ineligible: "INELIGIBLE";
+    readonly InventoryOutbound: "INVENTORY_OUTBOUND";
+    readonly Success: "SUCCESS";
+    readonly Validating: "VALIDATING";
+};
+export type OutboundStatus = typeof OutboundStatus[keyof typeof OutboundStatus];

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

@@ -0,0 +1,43 @@
+/**
+ * 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 { DimensionUnitOfMeasurement } from './dimension-unit-of-measurement';
+/**
+ * Dimensions of the package.
+ * @export
+ * @interface PackageDimensions
+ */
+export interface PackageDimensions {
+    /**
+     * Height of the package.
+     * @type {number}
+     * @memberof PackageDimensions
+     */
+    'height': number;
+    /**
+     * Length of the package.
+     * @type {number}
+     * @memberof PackageDimensions
+     */
+    'length': number;
+    /**
+     *
+     * @type {DimensionUnitOfMeasurement}
+     * @memberof PackageDimensions
+     */
+    'unitOfMeasurement': DimensionUnitOfMeasurement;
+    /**
+     * Width of the package.
+     * @type {number}
+     * @memberof PackageDimensions
+     */
+    'width': number;
+}

package/dist/types/api-model/models/package-volume.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 { VolumeUnitOfMeasurement } from './volume-unit-of-measurement';
+/**
+ * Represents the volume of the package with a unit of measurement.
+ * @export
+ * @interface PackageVolume
+ */
+export interface PackageVolume {
+    /**
+     *
+     * @type {VolumeUnitOfMeasurement}
+     * @memberof PackageVolume
+     */
+    'unitOfMeasurement': VolumeUnitOfMeasurement;
+    /**
+     * The package volume value.
+     * @type {number}
+     * @memberof PackageVolume
+     */
+    'volume': number;
+}

package/dist/types/api-model/models/package-weight.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 { WeightUnitOfMeasurement } from './weight-unit-of-measurement';
+/**
+ * Represents the weight of the package with a unit of measurement.
+ * @export
+ * @interface PackageWeight
+ */
+export interface PackageWeight {
+    /**
+     *
+     * @type {WeightUnitOfMeasurement}
+     * @memberof PackageWeight
+     */
+    'unitOfMeasurement': WeightUnitOfMeasurement;
+    /**
+     * The package weight value.
+     * @type {number}
+     * @memberof PackageWeight
+     */
+    'weight': number;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+/**
+ * Label page type.
+ * @export
+ * @enum {string}
+ */
+export declare const PageType: {
+    readonly ThermalNonpcp: "THERMAL_NONPCP";
+    readonly PlainPaper: "PLAIN_PAPER";
+    readonly Letter6: "LETTER_6";
+};
+export type PageType = typeof PageType[keyof typeof PageType];

package/dist/types/api-model/models/prep-details.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 { LabelOwner } from './label-owner';
+import type { PrepInstruction } from './prep-instruction';
+import type { PrepOwner } from './prep-owner';
+/**
+ * The preparation details for a product. This contains the prep category, prep owner, and label owner. Prep instructions are generated based on the specified category.
+ * @export
+ * @interface PrepDetails
+ */
+export interface PrepDetails {
+    /**
+     *
+     * @type {LabelOwner}
+     * @memberof PrepDetails
+     */
+    'labelOwner'?: LabelOwner;
+    /**
+     * The preparation category for shipping an item to Amazon\'s fulfillment network.
+     * @type {string}
+     * @memberof PrepDetails
+     */
+    'prepCategory'?: string;
+    /**
+     * Information that pertains to the preparation of inbound products. This is generated based on the specified category.
+     * @type {Array<PrepInstruction>}
+     * @memberof PrepDetails
+     */
+    'prepInstructions'?: Array<PrepInstruction>;
+    /**
+     *
+     * @type {PrepOwner}
+     * @memberof PrepDetails
+     */
+    'prepOwner'?: PrepOwner;
+}

package/dist/types/api-model/models/prep-instruction.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 { PrepOwner } from './prep-owner';
+/**
+ * Information pertaining to the preparation of inbound products.
+ * @export
+ * @interface PrepInstruction
+ */
+export interface PrepInstruction {
+    /**
+     *
+     * @type {PrepOwner}
+     * @memberof PrepInstruction
+     */
+    'prepOwner'?: PrepOwner;
+    /**
+     * The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.
+     * @type {string}
+     * @memberof PrepInstruction
+     */
+    'prepType'?: string;
+}

package/dist/types/api-model/models/prep-owner.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.
+ */
+/**
+ * The owner of the preparations, if special preparations are required.
+ * @export
+ * @enum {string}
+ */
+export declare const PrepOwner: {
+    readonly Amazon: "AMAZON";
+    readonly Self: "SELF";
+};
+export type PrepOwner = typeof PrepOwner[keyof typeof PrepOwner];

package/dist/types/api-model/models/product-attribute.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.
+ */
+/**
+ * Product instance attribute that is not described at the SKU level in the catalog.
+ * @export
+ * @interface ProductAttribute
+ */
+export interface ProductAttribute {
+    /**
+     * Product attribute name.
+     * @type {string}
+     * @memberof ProductAttribute
+     */
+    'name'?: string;
+    /**
+     * Product attribute value.
+     * @type {string}
+     * @memberof ProductAttribute
+     */
+    'value'?: string;
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 { PrepDetails } from './prep-details';
+import type { ProductAttribute } from './product-attribute';
+/**
+ * Represents a product with the SKU details and the corresponding quantity.
+ * @export
+ * @interface ProductQuantity
+ */
+export interface ProductQuantity {
+    /**
+     * Attributes for this instance of the product. For example, already-prepped, or other attributes that distinguish the product beyond the SKU.
+     * @type {Array<ProductAttribute>}
+     * @memberof ProductQuantity
+     */
+    'attributes'?: Array<ProductAttribute>;
+    /**
+     * Product quantity.
+     * @type {number}
+     * @memberof ProductQuantity
+     */
+    'quantity': number;
+    /**
+     * The seller or merchant SKU.
+     * @type {string}
+     * @memberof ProductQuantity
+     */
+    'sku': string;
+    /**
+     * The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @type {string}
+     * @memberof ProductQuantity
+     */
+    'expiration'?: string;
+    /**
+     *
+     * @type {PrepDetails}
+     * @memberof ProductQuantity
+     */
+    'prepDetails'?: PrepDetails;
+}

package/dist/types/api-model/models/shipment-labels.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 { LabelStatus } from './label-status';
+/**
+ * Shipment labels.
+ * @export
+ * @interface ShipmentLabels
+ */
+export interface ShipmentLabels {
+    /**
+     * URL to download generated labels.
+     * @type {string}
+     * @memberof ShipmentLabels
+     */
+    'labelDownloadURL'?: string;
+    /**
+     *
+     * @type {LabelStatus}
+     * @memberof ShipmentLabels
+     */
+    'labelStatus': LabelStatus;
+}