@sp-api-sdk/vendor-shipments-api-v1 1.6.15

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

@@ -0,0 +1,38 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ItemDetails } from './item-details';
+import { ItemQuantity } from './item-quantity';
+/**
+ * Carton/Pallet level details for the item.
+ * @export
+ * @interface ContainerItem
+ */
+export interface ContainerItem {
+    /**
+     * The reference number for the item. Please provide the itemSequenceNumber from the \'items\' segment to refer to that item\'s details here.
+     * @type {string}
+     * @memberof ContainerItem
+     */
+    itemReference: string;
+    /**
+     *
+     * @type {ItemQuantity}
+     * @memberof ContainerItem
+     */
+    shippedQuantity: ItemQuantity;
+    /**
+     *
+     * @type {ItemDetails}
+     * @memberof ContainerItem
+     */
+    itemDetails?: ItemDetails;
+}

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

@@ -0,0 +1,52 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Physical dimensional measurements of a container.
+ * @export
+ * @interface Dimensions
+ */
+export interface Dimensions {
+    /**
+     * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`.
+     * @type {string}
+     * @memberof Dimensions
+     */
+    length: string;
+    /**
+     * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`.
+     * @type {string}
+     * @memberof Dimensions
+     */
+    width: string;
+    /**
+     * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$`.
+     * @type {string}
+     * @memberof Dimensions
+     */
+    height: string;
+    /**
+     * The unit of measure for dimensions.
+     * @type {string}
+     * @memberof Dimensions
+     */
+    unitOfMeasure: DimensionsUnitOfMeasureEnum;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum DimensionsUnitOfMeasureEnum {
+    In = "In",
+    Ft = "Ft",
+    Meter = "Meter",
+    Yard = "Yard"
+}

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

@@ -0,0 +1,38 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface Duration
+ */
+export interface Duration {
+    /**
+     * Unit for duration.
+     * @type {string}
+     * @memberof Duration
+     */
+    durationUnit: DurationDurationUnitEnum;
+    /**
+     * Value for the duration in terms of the durationUnit.
+     * @type {number}
+     * @memberof Duration
+     */
+    durationValue: number;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum DurationDurationUnitEnum {
+    Days = "Days",
+    Months = "Months"
+}

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

@@ -0,0 +1,37 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Duration } from './duration';
+/**
+ *
+ * @export
+ * @interface Expiry
+ */
+export interface Expiry {
+    /**
+     * Production, packaging or assembly date determined by the manufacturer. Its meaning is determined based on the trade item context.
+     * @type {string}
+     * @memberof Expiry
+     */
+    manufacturerDate?: string;
+    /**
+     * The date that determines the limit of consumption or use of a product. Its meaning is determined based on the trade item context.
+     * @type {string}
+     * @memberof Expiry
+     */
+    expiryDate?: string;
+    /**
+     *
+     * @type {Duration}
+     * @memberof Expiry
+     */
+    expiryAfterDuration?: Duration;
+}

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

@@ -0,0 +1,68 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Route } from './route';
+import { Weight } from './weight';
+/**
+ *
+ * @export
+ * @interface ImportDetails
+ */
+export interface ImportDetails {
+    /**
+     * This is used for import purchase orders only. If the recipient requests, this field will contain the shipment method of payment.
+     * @type {string}
+     * @memberof ImportDetails
+     */
+    methodOfPayment?: ImportDetailsMethodOfPaymentEnum;
+    /**
+     * The container\'s seal number.
+     * @type {string}
+     * @memberof ImportDetails
+     */
+    sealNumber?: string;
+    /**
+     *
+     * @type {Route}
+     * @memberof ImportDetails
+     */
+    route?: Route;
+    /**
+     * Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if shipment has multiple containers.
+     * @type {string}
+     * @memberof ImportDetails
+     */
+    importContainers?: string;
+    /**
+     *
+     * @type {Weight}
+     * @memberof ImportDetails
+     */
+    billableWeight?: Weight;
+    /**
+     * Date on which the shipment is expected to be shipped. This value should not be in the past and not more than 60 days out in the future.
+     * @type {string}
+     * @memberof ImportDetails
+     */
+    estimatedShipByDate?: string;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum ImportDetailsMethodOfPaymentEnum {
+    PaidByBuyer = "PaidByBuyer",
+    CollectOnDelivery = "CollectOnDelivery",
+    DefinedByBuyerAndSeller = "DefinedByBuyerAndSeller",
+    FobPortOfCall = "FOBPortOfCall",
+    PrepaidBySeller = "PrepaidBySeller",
+    PaidBySeller = "PaidBySeller"
+}

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

@@ -0,0 +1,28 @@
+export * from './address';
+export * from './carton';
+export * from './carton-reference-details';
+export * from './container-identification';
+export * from './container-item';
+export * from './dimensions';
+export * from './duration';
+export * from './expiry';
+export * from './import-details';
+export * from './item';
+export * from './item-details';
+export * from './item-quantity';
+export * from './location';
+export * from './model-error';
+export * from './money';
+export * from './pallet';
+export * from './party-identification';
+export * from './route';
+export * from './shipment-confirmation';
+export * from './shipment-measurements';
+export * from './stop';
+export * from './submit-shipment-confirmations-request';
+export * from './submit-shipment-confirmations-response';
+export * from './tax-registration-details';
+export * from './transaction-reference';
+export * from './transportation-details';
+export * from './volume';
+export * from './weight';

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

@@ -0,0 +1,60 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Expiry } from './expiry';
+import { Money } from './money';
+/**
+ * Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate.
+ * @export
+ * @interface ItemDetails
+ */
+export interface ItemDetails {
+    /**
+     * The Amazon purchase order number for the shipment being confirmed. If the items in this shipment belong to multiple purchase order numbers that are in particular carton or pallet within the shipment, then provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character alpha-numeric code.
+     * @type {string}
+     * @memberof ItemDetails
+     */
+    purchaseOrderNumber?: string;
+    /**
+     * The batch or lot number associates an item with information the manufacturer considers relevant for traceability of the trade item to which the Element String is applied. The data may refer to the trade item itself or to items contained. This field is mandatory for all perishable items.
+     * @type {string}
+     * @memberof ItemDetails
+     */
+    lotNumber?: string;
+    /**
+     *
+     * @type {Expiry}
+     * @memberof ItemDetails
+     */
+    expiry?: Expiry;
+    /**
+     *
+     * @type {Money}
+     * @memberof ItemDetails
+     */
+    maximumRetailPrice?: Money;
+    /**
+     * Identification of the instructions on how specified item/carton/pallet should be handled.
+     * @type {string}
+     * @memberof ItemDetails
+     */
+    handlingCode?: ItemDetailsHandlingCodeEnum;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum ItemDetailsHandlingCodeEnum {
+    Oversized = "Oversized",
+    Fragile = "Fragile",
+    Food = "Food",
+    HandleWithCare = "HandleWithCare"
+}

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

@@ -0,0 +1,44 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Details of item quantity.
+ * @export
+ * @interface ItemQuantity
+ */
+export interface ItemQuantity {
+    /**
+     * Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level.
+     * @type {number}
+     * @memberof ItemQuantity
+     */
+    amount: number;
+    /**
+     * Unit of measure for the shipped quantity.
+     * @type {string}
+     * @memberof ItemQuantity
+     */
+    unitOfMeasure: ItemQuantityUnitOfMeasureEnum;
+    /**
+     * The case size, in the event that we ordered using cases. Otherwise, 1.
+     * @type {number}
+     * @memberof ItemQuantity
+     */
+    unitSize?: number;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum ItemQuantityUnitOfMeasureEnum {
+    Cases = "Cases",
+    Eaches = "Eaches"
+}

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

@@ -0,0 +1,50 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ItemDetails } from './item-details';
+import { ItemQuantity } from './item-quantity';
+/**
+ * Details of the item being shipped.
+ * @export
+ * @interface Item
+ */
+export interface Item {
+    /**
+     * Item sequence number for the item. The first item will be 001, the second 002, and so on. This number is used as a reference to refer to this item from the carton or pallet level.
+     * @type {string}
+     * @memberof Item
+     */
+    itemSequenceNumber: string;
+    /**
+     * Amazon Standard Identification Number (ASIN) of an item.
+     * @type {string}
+     * @memberof Item
+     */
+    amazonProductIdentifier?: string;
+    /**
+     * The vendor selected product identification of the item. Should be the same as was sent in the purchase order.
+     * @type {string}
+     * @memberof Item
+     */
+    vendorProductIdentifier?: string;
+    /**
+     *
+     * @type {ItemQuantity}
+     * @memberof Item
+     */
+    shippedQuantity: ItemQuantity;
+    /**
+     *
+     * @type {ItemDetails}
+     * @memberof Item
+     */
+    itemDetails?: ItemDetails;
+}

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

@@ -0,0 +1,36 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Location identifier.
+ * @export
+ * @interface Location
+ */
+export interface Location {
+    /**
+     * Type of location identification.
+     * @type {string}
+     * @memberof Location
+     */
+    type?: string;
+    /**
+     * Location code.
+     * @type {string}
+     * @memberof Location
+     */
+    locationCode?: string;
+    /**
+     * The two digit country code. In ISO 3166-1 alpha-2 format.
+     * @type {string}
+     * @memberof Location
+     */
+    countryCode?: string;
+}