@amazon-sp-api-release/amazon-sp-api-sdk-js 1.5.0 → 1.6.0

package/src/externalfulfillmentshipments_v2024_09_11/model/Shipment.js

@@ -0,0 +1,369 @@
+/**
+ * The Selling Partner API for Amazon External Fulfillment Shipments Processing
+ * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon's external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@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 { ApiClient } from '../ApiClient.js'
+import { Charge } from './Charge.js'
+import { InvoiceInfo } from './InvoiceInfo.js'
+import { MarketplaceAttributes } from './MarketplaceAttributes.js'
+import { Package } from './Package.js'
+import { PartyIdentificationInfo } from './PartyIdentificationInfo.js'
+import { ShipmentInfo } from './ShipmentInfo.js'
+import { ShipmentLineItem } from './ShipmentLineItem.js'
+import { ShipmentRequirements } from './ShipmentRequirements.js'
+import { ShippingInfo } from './ShippingInfo.js'
+
+/**
+ * The Shipment model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/Shipment
+ * @version 2024-09-11
+ */
+export class Shipment {
+  /**
+   * Constructs a new <code>Shipment</code>.
+   * Information about a shipment.
+   * @alias module:externalfulfillmentshipments_v2024_09_11/model/Shipment
+   * @class
+   * @param id {String} The shipment's ID.
+   * @param locationId {String} The location identifier of the seller's location in the marketplace channel to which the shipment has been created for fulfillment.
+   * @param marketplaceAttributes {MarketplaceAttributes}
+   * @param shipmentInfo {ShipmentInfo}
+   * @param shipmentRequirements {ShipmentRequirements}
+   * @param charges {[Charge]} The charges associated with the shipment.
+   * @param status {String} The current status of the shipment.
+   * @param lineItems {[ShipmentLineItem]} The line items in the shipment.
+   * @param shippingInfo {ShippingInfo}
+   * @param creationDateTime {String} A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+   * @param lastUpdatedDateTime {String} A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+   */
+  constructor (id, locationId, marketplaceAttributes, shipmentInfo, shipmentRequirements, charges, status, lineItems, shippingInfo, creationDateTime, lastUpdatedDateTime) {
+    this.id = id
+    this.locationId = locationId
+    this.marketplaceAttributes = marketplaceAttributes
+    this.shipmentInfo = shipmentInfo
+    this.shipmentRequirements = shipmentRequirements
+    this.charges = charges
+    this.status = status
+    this.lineItems = lineItems
+    this.shippingInfo = shippingInfo
+    this.creationDateTime = creationDateTime
+    this.lastUpdatedDateTime = lastUpdatedDateTime
+  }
+
+  /**
+   * Constructs a <code>Shipment</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {Shipment} obj Optional instance to populate.
+   * @return {Shipment} The populated <code>Shipment</code> instance.
+   */
+  static constructFromObject (data, obj) {
+    if (data) {
+      switch (typeof data) {
+        case 'string':
+          obj = String(data)
+          break
+        case 'number':
+          obj = Number(data)
+          break
+        case 'boolean':
+          obj = Boolean(data)
+          break
+      }
+      obj = obj || new Shipment()
+      if (data.hasOwnProperty('id')) { obj.id = ApiClient.convertToType(data.id, 'String') }
+      if (data.hasOwnProperty('locationId')) { obj.locationId = ApiClient.convertToType(data.locationId, 'String') }
+      if (data.hasOwnProperty('marketplaceAttributes')) { obj.marketplaceAttributes = MarketplaceAttributes.constructFromObject(data.marketplaceAttributes) }
+      if (data.hasOwnProperty('shipmentInfo')) { obj.shipmentInfo = ShipmentInfo.constructFromObject(data.shipmentInfo) }
+      if (data.hasOwnProperty('invoiceInfo')) { obj.invoiceInfo = InvoiceInfo.constructFromObject(data.invoiceInfo) }
+      if (data.hasOwnProperty('partyInfoList')) { obj.partyInfoList = ApiClient.convertToType(data.partyInfoList, [PartyIdentificationInfo]) }
+      if (data.hasOwnProperty('shipmentRequirements')) { obj.shipmentRequirements = ShipmentRequirements.constructFromObject(data.shipmentRequirements) }
+      if (data.hasOwnProperty('charges')) { obj.charges = ApiClient.convertToType(data.charges, [Charge]) }
+      if (data.hasOwnProperty('status')) { obj.status = ApiClient.convertToType(data.status, 'String') }
+      if (data.hasOwnProperty('subStatus')) { obj.subStatus = ApiClient.convertToType(data.subStatus, 'String') }
+      if (data.hasOwnProperty('lineItems')) { obj.lineItems = ApiClient.convertToType(data.lineItems, [ShipmentLineItem]) }
+      if (data.hasOwnProperty('shippingInfo')) { obj.shippingInfo = ShippingInfo.constructFromObject(data.shippingInfo) }
+      if (data.hasOwnProperty('packages')) { obj.packages = ApiClient.convertToType(data.packages, [Package]) }
+      if (data.hasOwnProperty('creationDateTime')) { obj.creationDateTime = ApiClient.convertToType(data.creationDateTime, 'String') }
+      if (data.hasOwnProperty('lastUpdatedDateTime')) { obj.lastUpdatedDateTime = ApiClient.convertToType(data.lastUpdatedDateTime, 'String') }
+      if (data.hasOwnProperty('earliestPackDateTime')) { obj.earliestPackDateTime = ApiClient.convertToType(data.earliestPackDateTime, 'String') }
+    }
+    return obj
+  }
+}
+
+/**
+ * The shipment's ID.
+ * @member {String} id
+ * @type {String}
+ */
+Shipment.prototype.id = undefined
+
+/**
+ * The location identifier of the seller's location in the marketplace channel to which the shipment has been created for fulfillment.
+ * @member {String} locationId
+ * @type {String}
+ */
+Shipment.prototype.locationId = undefined
+
+/**
+ * @member {MarketplaceAttributes} marketplaceAttributes
+ * @type {MarketplaceAttributes}
+ */
+Shipment.prototype.marketplaceAttributes = undefined
+
+/**
+ * @member {ShipmentInfo} shipmentInfo
+ * @type {ShipmentInfo}
+ */
+Shipment.prototype.shipmentInfo = undefined
+
+/**
+ * @member {InvoiceInfo} invoiceInfo
+ * @type {InvoiceInfo}
+ */
+Shipment.prototype.invoiceInfo = undefined
+
+/**
+ * All involved party identification and metadata for the vendor, buyer, and seller. Applicable for direct-fulfillment sellers.
+ * @member {[PartyIdentificationInfo]} partyInfoList
+ * @type {[PartyIdentificationInfo]}
+ */
+Shipment.prototype.partyInfoList = undefined
+
+/**
+ * @member {ShipmentRequirements} shipmentRequirements
+ * @type {ShipmentRequirements}
+ */
+Shipment.prototype.shipmentRequirements = undefined
+
+/**
+ * The charges associated with the shipment.
+ * @member {[Charge]} charges
+ * @type {[Charge]}
+ */
+Shipment.prototype.charges = undefined
+
+/**
+ * Allowed values for the <code>status</code> property.
+ * @enum {String}
+ * @readonly
+ */
+Shipment.StatusEnum = {
+
+  /**
+     * value: "CREATED"
+     * @const
+     */
+  CREATED: 'CREATED',
+
+  /**
+     * value: "ACCEPTED"
+     * @const
+     */
+  ACCEPTED: 'ACCEPTED',
+
+  /**
+     * value: "CONFIRMED"
+     * @const
+     */
+  CONFIRMED: 'CONFIRMED',
+
+  /**
+     * value: "PACKAGE_CREATED"
+     * @const
+     */
+  PACKAGE_CREATED: 'PACKAGE_CREATED',
+
+  /**
+     * value: "PICKUP_SLOT_RETRIEVED"
+     * @const
+     */
+  PICKUP_SLOT_RETRIEVED: 'PICKUP_SLOT_RETRIEVED',
+
+  /**
+     * value: "INVOICE_GENERATED"
+     * @const
+     */
+  INVOICE_GENERATED: 'INVOICE_GENERATED',
+
+  /**
+     * value: "SHIPLABEL_GENERATED"
+     * @const
+     */
+  SHIPLABEL_GENERATED: 'SHIPLABEL_GENERATED',
+
+  /**
+     * value: "CANCELLED"
+     * @const
+     */
+  CANCELLED: 'CANCELLED',
+
+  /**
+     * value: "SHIPPED"
+     * @const
+     */
+  SHIPPED: 'SHIPPED',
+
+  /**
+     * value: "DELIVERED"
+     * @const
+     */
+  DELIVERED: 'DELIVERED'
+}
+
+/**
+ * The current status of the shipment.
+ * @member {String} status
+ * @type {String}
+ */
+Shipment.prototype.status = undefined
+
+/**
+ * Allowed values for the <code>subStatus</code> property.
+ * @enum {String}
+ * @readonly
+ */
+Shipment.SubStatusEnum = {
+
+  /**
+     * value: "PENDING_SCHEDULE"
+     * @const
+     */
+  PENDING_SCHEDULE: 'PENDING_SCHEDULE',
+
+  /**
+     * value: "PENDING_PICKUP"
+     * @const
+     */
+  PENDING_PICKUP: 'PENDING_PICKUP',
+
+  /**
+     * value: "PENDING_DROP_OFF"
+     * @const
+     */
+  PENDING_DROP_OFF: 'PENDING_DROP_OFF',
+
+  /**
+     * value: "LABEL_CANCELED"
+     * @const
+     */
+  LABEL_CANCELED: 'LABEL_CANCELED',
+
+  /**
+     * value: "PICKED_UP"
+     * @const
+     */
+  PICKED_UP: 'PICKED_UP',
+
+  /**
+     * value: "DROPPED_OFF"
+     * @const
+     */
+  DROPPED_OFF: 'DROPPED_OFF',
+
+  /**
+     * value: "AT_ORIGIN_FC"
+     * @const
+     */
+  AT_ORIGIN_FC: 'AT_ORIGIN_FC',
+
+  /**
+     * value: "AT_DESTINATION_FC"
+     * @const
+     */
+  AT_DESTINATION_FC: 'AT_DESTINATION_FC',
+
+  /**
+     * value: "DELIVERED"
+     * @const
+     */
+  DELIVERED: 'DELIVERED',
+
+  /**
+     * value: "NOT_DELIVERED"
+     * @const
+     */
+  NOT_DELIVERED: 'NOT_DELIVERED',
+
+  /**
+     * value: "UNDELIVERABLE"
+     * @const
+     */
+  UNDELIVERABLE: 'UNDELIVERABLE',
+
+  /**
+     * value: "LOST"
+     * @const
+     */
+  LOST: 'LOST',
+
+  /**
+     * value: "OUT_FOR_DELIVERY"
+     * @const
+     */
+  OUT_FOR_DELIVERY: 'OUT_FOR_DELIVERY',
+
+  /**
+     * value: "DAMAGED"
+     * @const
+     */
+  DAMAGED: 'DAMAGED'
+}
+
+/**
+ * The sub status of the shipment.
+ * @member {String} subStatus
+ * @type {String}
+ */
+Shipment.prototype.subStatus = undefined
+
+/**
+ * The line items in the shipment.
+ * @member {[ShipmentLineItem]} lineItems
+ * @type {[ShipmentLineItem]}
+ */
+Shipment.prototype.lineItems = undefined
+
+/**
+ * @member {ShippingInfo} shippingInfo
+ * @type {ShippingInfo}
+ */
+Shipment.prototype.shippingInfo = undefined
+
+/**
+ * The list of packages in the shipment.
+ * @member {[Package]} packages
+ * @type {[Package]}
+ */
+Shipment.prototype.packages = undefined
+
+/**
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+ * @member {String} creationDateTime
+ * @type {String}
+ */
+Shipment.prototype.creationDateTime = undefined
+
+/**
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+ * @member {String} lastUpdatedDateTime
+ * @type {String}
+ */
+Shipment.prototype.lastUpdatedDateTime = undefined
+
+/**
+ * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+ * @member {String} earliestPackDateTime
+ * @type {String}
+ */
+Shipment.prototype.earliestPackDateTime = undefined

package/src/externalfulfillmentshipments_v2024_09_11/model/ShipmentAcknowledgementRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The ShipmentAcknowledgementRequest model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/ShipmentAcknowledgementRequest
+ * @version 2024-09-11
+ */
+export class ShipmentAcknowledgementRequest {
+    /**
+     * Constructs a <code>ShipmentAcknowledgementRequest</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {ShipmentAcknowledgementRequest} obj Optional instance to populate.
+     * @return {ShipmentAcknowledgementRequest} The populated <code>ShipmentAcknowledgementRequest</code> instance.
+     */
+    static constructFromObject(data: any, obj: ShipmentAcknowledgementRequest): ShipmentAcknowledgementRequest;
+    /**
+     * Constructs a new <code>ShipmentAcknowledgementRequest</code>.
+     * Information about the shipment and its line items, used to confirm or reject line items.
+     * @alias module:externalfulfillmentshipments_v2024_09_11/model/ShipmentAcknowledgementRequest
+     * @class
+     * @param lineItems {[LineItemWithReason]} Details about the line items from the shipment that are being confirmed or rejected by the seller.
+     */
+    constructor(lineItems: [LineItemWithReason]);
+    lineItems: [LineItemWithReason];
+    /**
+     * A unique identifier for every shipment rejection.
+     * @member {String} referenceId
+     * @type {String}
+     */
+    referenceId: string;
+}
+import { LineItemWithReason } from './LineItemWithReason.js';
+//# sourceMappingURL=ShipmentAcknowledgementRequest.d.ts.map

package/src/externalfulfillmentshipments_v2024_09_11/model/ShipmentAcknowledgementRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ShipmentAcknowledgementRequest.d.ts","sourceRoot":"","sources":["ShipmentAcknowledgementRequest.js"],"names":[],"mappings":"AAgBA;;;;GAIG;AACH;IAYE;;;;;;OAMG;IACH,2CAHW,8BAA8B,GAC7B,8BAA8B,CAoBzC;IApCD;;;;;;OAMG;IACH,uBAFqB,CAAC,kBAAkB,CAAC,EAIxC;IADC,gCAA0B;IA+B9B;;;;OAIG;IACH,oBAAoD;CAPnD;mCA7CkC,yBAAyB"}

package/src/externalfulfillmentshipments_v2024_09_11/model/ShipmentAcknowledgementRequest.js

@@ -0,0 +1,74 @@
+/**
+ * The Selling Partner API for Amazon External Fulfillment Shipments Processing
+ * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon's external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@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 { ApiClient } from '../ApiClient.js'
+import { LineItemWithReason } from './LineItemWithReason.js'
+
+/**
+ * The ShipmentAcknowledgementRequest model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/ShipmentAcknowledgementRequest
+ * @version 2024-09-11
+ */
+export class ShipmentAcknowledgementRequest {
+  /**
+   * Constructs a new <code>ShipmentAcknowledgementRequest</code>.
+   * Information about the shipment and its line items, used to confirm or reject line items.
+   * @alias module:externalfulfillmentshipments_v2024_09_11/model/ShipmentAcknowledgementRequest
+   * @class
+   * @param lineItems {[LineItemWithReason]} Details about the line items from the shipment that are being confirmed or rejected by the seller.
+   */
+  constructor (lineItems) {
+    this.lineItems = lineItems
+  }
+
+  /**
+   * Constructs a <code>ShipmentAcknowledgementRequest</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {ShipmentAcknowledgementRequest} obj Optional instance to populate.
+   * @return {ShipmentAcknowledgementRequest} The populated <code>ShipmentAcknowledgementRequest</code> instance.
+   */
+  static constructFromObject (data, obj) {
+    if (data) {
+      switch (typeof data) {
+        case 'string':
+          obj = String(data)
+          break
+        case 'number':
+          obj = Number(data)
+          break
+        case 'boolean':
+          obj = Boolean(data)
+          break
+      }
+      obj = obj || new ShipmentAcknowledgementRequest()
+      if (data.hasOwnProperty('referenceId')) { obj.referenceId = ApiClient.convertToType(data.referenceId, 'String') }
+      if (data.hasOwnProperty('lineItems')) { obj.lineItems = ApiClient.convertToType(data.lineItems, [LineItemWithReason]) }
+    }
+    return obj
+  }
+}
+
+/**
+ * A unique identifier for every shipment rejection.
+ * @member {String} referenceId
+ * @type {String}
+ */
+ShipmentAcknowledgementRequest.prototype.referenceId = undefined
+
+/**
+ * Details about the line items from the shipment that are being confirmed or rejected by the seller.
+ * @member {[LineItemWithReason]} lineItems
+ * @type {[LineItemWithReason]}
+ */
+ShipmentAcknowledgementRequest.prototype.lineItems = undefined

package/src/externalfulfillmentshipments_v2024_09_11/model/ShipmentInfo.d.ts

@@ -0,0 +1,75 @@
+/**
+ * The ShipmentInfo model module.
+ * @module externalfulfillmentshipments_v2024_09_11/model/ShipmentInfo
+ * @version 2024-09-11
+ */
+export class ShipmentInfo {
+    /**
+     * Constructs a <code>ShipmentInfo</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {ShipmentInfo} obj Optional instance to populate.
+     * @return {ShipmentInfo} The populated <code>ShipmentInfo</code> instance.
+     */
+    static constructFromObject(data: any, obj: ShipmentInfo): ShipmentInfo;
+    /**
+     * Constructs a new <code>ShipmentInfo</code>.
+     * High-level details of the shipment.
+     * @alias module:externalfulfillmentshipments_v2024_09_11/model/ShipmentInfo
+     * @class
+     * @param shipmentType {String} The type of shipment.
+     * @param numberOfUnits {Number} Total number of units in the shipment.
+     * @param priority {Priority}
+     * @param buyerOrderId {String} The buyer's order ID.
+     */
+    constructor(shipmentType: string, numberOfUnits: number, priority: Priority, buyerOrderId: string);
+    shipmentType: string;
+    numberOfUnits: number;
+    priority: Priority;
+    buyerOrderId: string;
+    /**
+     * @member {ReplacedShipmentInfo} originalShipmentInfo
+     * @type {ReplacedShipmentInfo}
+     */
+    originalShipmentInfo: ReplacedShipmentInfo;
+    /**
+     * A list of order statuses for which the marketplace allows order rejection (seller cancellation). If the order has a status that does not belong to this list, then seller cancellation is not possible.
+     * @member {[String]} orderStatesEligibleForRejection
+     * @type {[String]}
+     */
+    orderStatesEligibleForRejection: [string];
+    /**
+     * The timestamp of when the order was placed, in UTC
+     * @member {String} orderPlacedTimestamp
+     * @type {String}
+     */
+    orderPlacedTimestamp: string;
+    /**
+     * The source of the order operation.
+     * @member {String} processingSource
+     * @type {String}
+     */
+    processingSource: string;
+}
+export namespace ShipmentInfo {
+    namespace ShipmentTypeEnum {
+        let NEW: string;
+        let EXCHANGE: string;
+        let REPLACEMENT: string;
+    }
+    /**
+     * *
+     */
+    type ShipmentTypeEnum = string;
+    namespace ProcessingSourceEnum {
+        let EXTERNAL_PLATFORM: string;
+        let INTERNAL_PLATFORM: string;
+    }
+    /**
+     * *
+     */
+    type ProcessingSourceEnum = string;
+}
+import { Priority } from './Priority.js';
+import { ReplacedShipmentInfo } from './ReplacedShipmentInfo.js';
+//# sourceMappingURL=ShipmentInfo.d.ts.map

package/src/externalfulfillmentshipments_v2024_09_11/model/ShipmentInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ShipmentInfo.d.ts","sourceRoot":"","sources":["ShipmentInfo.js"],"names":[],"mappings":"AAiBA;;;;GAIG;AACH;IAkBE;;;;;;OAMG;IACH,2CAHW,YAAY,GACX,YAAY,CA0BvB;IAhDD;;;;;;;;;OASG;IACH,mEAHoB,QAAQ,wBAQ3B;IAJC,qBAAgC;IAChC,sBAAkC;IAClC,mBAAwB;IACxB,qBAAgC;IAsEpC;;;OAGG;IACH,sBAFU,oBAAoB,CAEa;IAsB3C;;;;OAIG;IACH,iCAFU,QAAQ,CAEoC;IAEtD;;;;OAIG;IACH,6BAA2C;IAsB3C;;;;OAIG;IACH,yBAAuC;CApGtC;;;;;;;;;;;;;;;;;;;;yBA1DwB,eAAe;qCACH,2BAA2B"}