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

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

@@ -0,0 +1,120 @@
+/**
+ * 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 { CarrierCode } from './carrier-code';
+import type { DistributionPackageQuantity } from './distribution-package-quantity';
+import type { InboundShipmentStatus } from './inbound-shipment-status';
+import type { InventoryQuantity } from './inventory-quantity';
+import type { SkuQuantity } from './sku-quantity';
+/**
+ * Represents an AWD inbound shipment.
+ * @export
+ * @interface InboundShipment
+ */
+export interface InboundShipment {
+    /**
+     *
+     * @type {CarrierCode}
+     * @memberof InboundShipment
+     */
+    'carrierCode'?: CarrierCode;
+    /**
+     * Timestamp when the shipment was created. The date is returned in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
+     * @type {string}
+     * @memberof InboundShipment
+     */
+    'createdAt'?: string;
+    /**
+     *
+     * @type {Address}
+     * @memberof InboundShipment
+     */
+    'destinationAddress': Address;
+    /**
+     * Client-provided reference ID that can correlate this shipment to client resources. For example, to map this shipment to an internal bookkeeping order record.
+     * @type {string}
+     * @memberof InboundShipment
+     */
+    'externalReferenceId'?: string;
+    /**
+     * The AWD inbound order ID that this inbound shipment belongs to.
+     * @type {string}
+     * @memberof InboundShipment
+     */
+    'orderId': string;
+    /**
+     *
+     * @type {Address}
+     * @memberof InboundShipment
+     */
+    'originAddress': Address;
+    /**
+     * Quantity received (at the receiving end) as part of this shipment.
+     * @type {Array<InventoryQuantity>}
+     * @memberof InboundShipment
+     */
+    'receivedQuantity'?: Array<InventoryQuantity>;
+    /**
+     * Timestamp when the shipment will be shipped.
+     * @type {string}
+     * @memberof InboundShipment
+     */
+    'shipBy'?: string;
+    /**
+     * Packages that are part of this shipment.
+     * @type {Array<DistributionPackageQuantity>}
+     * @memberof InboundShipment
+     */
+    'shipmentContainerQuantities': Array<DistributionPackageQuantity>;
+    /**
+     * Unique shipment ID.
+     * @type {string}
+     * @memberof InboundShipment
+     */
+    'shipmentId': string;
+    /**
+     * Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW.
+     * @type {Array<SkuQuantity>}
+     * @memberof InboundShipment
+     */
+    'shipmentSkuQuantities'?: Array<SkuQuantity>;
+    /**
+     * Assigned region where the order will be shipped. This can differ from what was passed as preference. AWD currently supports following region IDs: [us-west, us-east]
+     * @type {string}
+     * @memberof InboundShipment
+     */
+    'destinationRegion'?: string;
+    /**
+     *
+     * @type {InboundShipmentStatus}
+     * @memberof InboundShipment
+     */
+    'shipmentStatus': InboundShipmentStatus;
+    /**
+     * Carrier-unique tracking ID for this shipment.
+     * @type {string}
+     * @memberof InboundShipment
+     */
+    'trackingId'?: string;
+    /**
+     * Timestamp when the shipment was updated. The date is returned in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
+     * @type {string}
+     * @memberof InboundShipment
+     */
+    'updatedAt'?: string;
+    /**
+     * An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking.
+     * @type {string}
+     * @memberof InboundShipment
+     */
+    'warehouseReferenceId'?: string;
+}

package/dist/types/api-model/models/inbound-status.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.
+ */
+/**
+ * The supported statuses for an inbound order.
+ * @export
+ * @enum {string}
+ */
+export declare const InboundStatus: {
+    readonly Draft: "DRAFT";
+    readonly Validating: "VALIDATING";
+    readonly Confirmed: "CONFIRMED";
+    readonly Closed: "CLOSED";
+    readonly Expired: "EXPIRED";
+    readonly Cancelled: "CANCELLED";
+};
+export type InboundStatus = typeof InboundStatus[keyof typeof InboundStatus];

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

@@ -0,0 +1,65 @@
+export * from './address';
+export * from './carrier-code';
+export * from './carrier-code-type';
+export * from './dimension-unit-of-measurement';
+export * from './distribution-package';
+export * from './distribution-package-contents';
+export * from './distribution-package-quantity';
+export * from './distribution-package-type';
+export * from './error-list';
+export * from './expiration-details';
+export * from './format-type';
+export * from './inbound-eligibility';
+export * from './inbound-eligibility-status';
+export * from './inbound-order';
+export * from './inbound-order-creation-data';
+export * from './inbound-order-reference';
+export * from './inbound-packages';
+export * from './inbound-preferences';
+export * from './inbound-shipment';
+export * from './inbound-shipment-status';
+export * from './inbound-shipment-summary';
+export * from './inbound-status';
+export * from './inventory-details';
+export * from './inventory-details-visibility';
+export * from './inventory-listing';
+export * from './inventory-quantity';
+export * from './inventory-summary';
+export * from './inventory-unit-of-measurement';
+export * from './label-owner';
+export * from './label-status';
+export * from './measurement-data';
+export * from './model-error';
+export * from './order-attribute';
+export * from './order-ineligibility-reason';
+export * from './order-preference';
+export * from './order-preference-value';
+export * from './outbound-execution-error';
+export * from './outbound-listing';
+export * from './outbound-order';
+export * from './outbound-order-creation-data';
+export * from './outbound-order-reference';
+export * from './outbound-shipment';
+export * from './outbound-shipment-status';
+export * from './outbound-status';
+export * from './package-dimensions';
+export * from './package-volume';
+export * from './package-weight';
+export * from './page-type';
+export * from './prep-details';
+export * from './prep-instruction';
+export * from './prep-owner';
+export * from './product-attribute';
+export * from './product-quantity';
+export * from './shipment-labels';
+export * from './shipment-listing';
+export * from './shipment-sortable-field';
+export * from './sku-eligibility';
+export * from './sku-ineligibility-reason';
+export * from './sku-quantities-visibility';
+export * from './sku-quantity';
+export * from './sort-order';
+export * from './tracking-details';
+export * from './transportation-details';
+export * from './volume-unit-of-measurement';
+export * from './weight-unit-of-measurement';

package/dist/types/api-model/models/inventory-details-visibility.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 to specify if returned summaries should include additional summarized inventory details and quantities.
+ * @export
+ * @enum {string}
+ */
+export declare const InventoryDetailsVisibility: {
+    readonly Show: "SHOW";
+    readonly Hide: "HIDE";
+};
+export type InventoryDetailsVisibility = typeof InventoryDetailsVisibility[keyof typeof InventoryDetailsVisibility];

package/dist/types/api-model/models/inventory-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.
+ */
+/**
+ * Additional inventory details. This object is only displayed if the details parameter in the request is set to `SHOW`.
+ * @export
+ * @interface InventoryDetails
+ */
+export interface InventoryDetails {
+    /**
+     * Quantity that is available for downstream channel replenishment.
+     * @type {number}
+     * @memberof InventoryDetails
+     */
+    'availableDistributableQuantity'?: number;
+    /**
+     * Quantity that is reserved for a downstream channel replenishment order that is being prepared for shipment.
+     * @type {number}
+     * @memberof InventoryDetails
+     */
+    'reservedDistributableQuantity'?: number;
+}

package/dist/types/api-model/models/inventory-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 { InventorySummary } from './inventory-summary';
+/**
+ * AWD inventory payload.
+ * @export
+ * @interface InventoryListing
+ */
+export interface InventoryListing {
+    /**
+     * List of inventory summaries.
+     * @type {Array<InventorySummary>}
+     * @memberof InventoryListing
+     */
+    'inventory': Array<InventorySummary>;
+    /**
+     * A 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 InventoryListing
+     */
+    'nextToken'?: string;
+}

package/dist/types/api-model/models/inventory-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 { InventoryUnitOfMeasurement } from './inventory-unit-of-measurement';
+/**
+ * Quantity of inventory with an associated measurement unit context.
+ * @export
+ * @interface InventoryQuantity
+ */
+export interface InventoryQuantity {
+    /**
+     * Quantity of the respective inventory.
+     * @type {number}
+     * @memberof InventoryQuantity
+     */
+    'quantity': number;
+    /**
+     *
+     * @type {InventoryUnitOfMeasurement}
+     * @memberof InventoryQuantity
+     */
+    'unitOfMeasurement': InventoryUnitOfMeasurement;
+}

package/dist/types/api-model/models/inventory-summary.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 { ExpirationDetails } from './expiration-details';
+import type { InventoryDetails } from './inventory-details';
+/**
+ * Summary of inventory per SKU.
+ * @export
+ * @interface InventorySummary
+ */
+export interface InventorySummary {
+    /**
+     * The expiration details of the inventory. This object will only appear if the `details` parameter in the request is set to `SHOW`.
+     * @type {Array<ExpirationDetails>}
+     * @memberof InventorySummary
+     */
+    'expirationDetails'?: Array<ExpirationDetails>;
+    /**
+     *
+     * @type {InventoryDetails}
+     * @memberof InventorySummary
+     */
+    'inventoryDetails'?: InventoryDetails;
+    /**
+     * The seller or merchant SKU.
+     * @type {string}
+     * @memberof InventorySummary
+     */
+    'sku': string;
+    /**
+     * Total quantity that is in-transit from the seller and has not yet been received at an AWD Distribution Center
+     * @type {number}
+     * @memberof InventorySummary
+     */
+    'totalInboundQuantity'?: number;
+    /**
+     * Total quantity that is present in AWD distribution centers.
+     * @type {number}
+     * @memberof InventorySummary
+     */
+    'totalOnhandQuantity'?: number;
+}

package/dist/types/api-model/models/inventory-unit-of-measurement.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.
+ */
+/**
+ * Unit of measurement for the inventory.
+ * @export
+ * @enum {string}
+ */
+export declare const InventoryUnitOfMeasurement: {
+    readonly ProductUnits: "PRODUCT_UNITS";
+    readonly Cases: "CASES";
+    readonly Pallets: "PALLETS";
+};
+export type InventoryUnitOfMeasurement = typeof InventoryUnitOfMeasurement[keyof typeof InventoryUnitOfMeasurement];

package/dist/types/api-model/models/label-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 entity that labels the products.
+ * @export
+ * @enum {string}
+ */
+export declare const LabelOwner: {
+    readonly Amazon: "AMAZON";
+    readonly Self: "SELF";
+};
+export type LabelOwner = typeof LabelOwner[keyof typeof LabelOwner];

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

@@ -0,0 +1,23 @@
+/**
+ * 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 status of your label.
+ * @export
+ * @enum {string}
+ */
+export declare const LabelStatus: {
+    readonly Generating: "GENERATING";
+    readonly Generated: "GENERATED";
+    readonly GenerationFailed: "GENERATION_FAILED";
+    readonly NotReady: "NOT_READY";
+};
+export type LabelStatus = typeof LabelStatus[keyof typeof LabelStatus];

package/dist/types/api-model/models/measurement-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 { PackageDimensions } from './package-dimensions';
+import type { PackageVolume } from './package-volume';
+import type { PackageWeight } from './package-weight';
+/**
+ * Package weight and dimension.
+ * @export
+ * @interface MeasurementData
+ */
+export interface MeasurementData {
+    /**
+     *
+     * @type {PackageDimensions}
+     * @memberof MeasurementData
+     */
+    'dimensions'?: PackageDimensions;
+    /**
+     *
+     * @type {PackageVolume}
+     * @memberof MeasurementData
+     */
+    'volume'?: PackageVolume;
+    /**
+     *
+     * @type {PackageWeight}
+     * @memberof MeasurementData
+     */
+    'weight': PackageWeight;
+}

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

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+/**
+ * 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;
+    /**
+     * Additional details that can help the caller understand or fix the issue.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'details'?: string;
+    /**
+     * A message that describes the error condition.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'message': string;
+}

package/dist/types/api-model/models/order-attribute.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 { OrderPreference } from './order-preference';
+import type { OrderPreferenceValue } from './order-preference-value';
+/**
+ * Consists of the order preference and corresponding preference value.
+ * @export
+ * @interface OrderAttribute
+ */
+export interface OrderAttribute {
+    /**
+     *
+     * @type {OrderPreference}
+     * @memberof OrderAttribute
+     */
+    'orderPreference': OrderPreference;
+    /**
+     *
+     * @type {OrderPreferenceValue}
+     * @memberof OrderAttribute
+     */
+    'orderPreferenceValue': OrderPreferenceValue;
+}

package/dist/types/api-model/models/order-ineligibility-reason.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.
+ */
+/**
+ * Represents one ineligibility reason for the order (there can be multiple reasons).
+ * @export
+ * @interface OrderIneligibilityReason
+ */
+export interface OrderIneligibilityReason {
+    /**
+     * Code for the order ineligibility.
+     * @type {string}
+     * @memberof OrderIneligibilityReason
+     */
+    'code': string;
+    /**
+     * Description detailing the ineligibility reason of the order.
+     * @type {string}
+     * @memberof OrderIneligibilityReason
+     */
+    'description': string;
+}

package/dist/types/api-model/models/order-preference-value.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.
+ */
+/**
+ * Value for the order preference.
+ * @export
+ * @enum {string}
+ */
+export declare const OrderPreferenceValue: {
+    readonly Set: "SET";
+    readonly Unset: "UNSET";
+};
+export type OrderPreferenceValue = typeof OrderPreferenceValue[keyof typeof OrderPreferenceValue];

package/dist/types/api-model/models/order-preference.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.
+ */
+/**
+ * Supported preferences for the distribution order.
+ * @export
+ * @enum {string}
+ */
+export declare const OrderPreference: {
+    readonly PartialOrder: "PARTIAL_ORDER";
+};
+export type OrderPreference = typeof OrderPreference[keyof typeof OrderPreference];

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

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+/**
+ * Execution errors associated with the outbound order. This field will be populated if the order failed validation.
+ * @export
+ * @interface OutboundExecutionError
+ */
+export interface OutboundExecutionError {
+    /**
+     * Failure code details for the error.
+     * @type {string}
+     * @memberof OutboundExecutionError
+     */
+    'failureCode': string;
+    /**
+     * Failure reasons for the error.
+     * @type {Array<string>}
+     * @memberof OutboundExecutionError
+     */
+    'failureReasons': Array<string>;
+    /**
+     * MSKU associated with the error.
+     * @type {string}
+     * @memberof OutboundExecutionError
+     */
+    'sku'?: string;
+}