@sp-api-sdk/orders-api-v0 5.0.0 → 5.1.1

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

@@ -12,7 +12,6 @@
 import type { AmazonPrograms } from './amazon-programs';
 import type { AssociatedItem } from './associated-item';
 import type { BuyerRequestedCancel } from './buyer-requested-cancel';
-import type { ExportInfo } from './export-info';
 import type { ItemBuyerInfo } from './item-buyer-info';
 import type { Measurement } from './measurement';
 import type { Money } from './money';
@@ -23,256 +22,111 @@ import type { SubstitutionPreferences } from './substitution-preferences';
 import type { TaxCollection } from './tax-collection';
 /**
  * A single order item.
- * @export
- * @interface OrderItem
  */
 export interface OrderItem {
     /**
      * The item\'s Amazon Standard Identification Number (ASIN).
-     * @type {string}
-     * @memberof OrderItem
      */
     'ASIN': string;
     /**
      * The item\'s seller stock keeping unit (SKU).
-     * @type {string}
-     * @memberof OrderItem
      */
     'SellerSKU'?: string;
     /**
      * An Amazon-defined order item identifier.
-     * @type {string}
-     * @memberof OrderItem
      */
     'OrderItemId': string;
     /**
      * A list of associated items that a customer has purchased with a product. For example, a tire installation service purchased with tires.
-     * @type {Array<AssociatedItem>}
-     * @memberof OrderItem
      */
     'AssociatedItems'?: Array<AssociatedItem>;
     /**
      * The item\'s name.
-     * @type {string}
-     * @memberof OrderItem
      */
     'Title'?: string;
     /**
      * The number of items in the order.
-     * @type {number}
-     * @memberof OrderItem
      */
     'QuantityOrdered': number;
     /**
      * The number of items shipped.
-     * @type {number}
-     * @memberof OrderItem
      */
     'QuantityShipped'?: number;
-    /**
-     *
-     * @type {ProductInfoDetail}
-     * @memberof OrderItem
-     */
     'ProductInfo'?: ProductInfoDetail;
-    /**
-     *
-     * @type {PointsGrantedDetail}
-     * @memberof OrderItem
-     */
     'PointsGranted'?: PointsGrantedDetail;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItem
-     */
     'ItemPrice'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItem
-     */
     'ShippingPrice'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItem
-     */
     'ItemTax'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItem
-     */
     'ShippingTax'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItem
-     */
     'ShippingDiscount'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItem
-     */
     'ShippingDiscountTax'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItem
-     */
     'PromotionDiscount'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItem
-     */
     'PromotionDiscountTax'?: Money;
     /**
      * A list of promotion identifiers provided by the seller when the promotions were created.
-     * @type {Array<string>}
-     * @memberof OrderItem
      */
     'PromotionIds'?: Array<string>;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItem
-     */
     'CODFee'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItem
-     */
     'CODFeeDiscount'?: Money;
     /**
      * Indicates whether the item is a gift.  **Possible values**: `true` and `false`.
-     * @type {string}
-     * @memberof OrderItem
      */
     'IsGift'?: string;
     /**
      * The condition of the item, as described by the seller.
-     * @type {string}
-     * @memberof OrderItem
      */
     'ConditionNote'?: string;
     /**
      * The condition of the item.  **Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, and `Club`.
-     * @type {string}
-     * @memberof OrderItem
      */
     'ConditionId'?: string;
     /**
      * The subcondition of the item.  **Possible values**: `New`, `Mint`, `Very Good`, `Good`, `Acceptable`, `Poor`, `Club`, `OEM`, `Warranty`, `Refurbished Warranty`, `Refurbished`, `Open Box`, `Any`, and `Other`.
-     * @type {string}
-     * @memberof OrderItem
      */
     'ConditionSubtypeId'?: string;
     /**
      * The start date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
-     * @type {string}
-     * @memberof OrderItem
      */
     'ScheduledDeliveryStartDate'?: string;
     /**
      * The end date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
-     * @type {string}
-     * @memberof OrderItem
      */
     'ScheduledDeliveryEndDate'?: string;
     /**
      * Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business).   **Possible values**: `BusinessPrice`
-     * @type {string}
-     * @memberof OrderItem
      */
     'PriceDesignation'?: string;
-    /**
-     *
-     * @type {TaxCollection}
-     * @memberof OrderItem
-     */
     'TaxCollection'?: TaxCollection;
     /**
      * When true, the product type for this item has a serial number.   Only returned for Amazon Easy Ship orders.
-     * @type {boolean}
-     * @memberof OrderItem
      */
     'SerialNumberRequired'?: boolean;
     /**
      * When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by:  **1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN). **2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode. **QR code SN:** Submit the URL that the QR code generates.
-     * @type {boolean}
-     * @memberof OrderItem
      */
     'IsTransparency'?: boolean;
     /**
      * The IOSS number of the marketplace. Sellers shipping to the EU from outside the EU must provide this IOSS number to their carrier when Amazon has collected the VAT on the sale.
-     * @type {string}
-     * @memberof OrderItem
      */
     'IossNumber'?: string;
     /**
      * The store chain store identifier. Linked to a specific store in a store chain.
-     * @type {string}
-     * @memberof OrderItem
      */
     'StoreChainStoreId'?: string;
     /**
      * The category of deemed reseller. This applies to selling partners that are not based in the EU and is used to help them meet the VAT Deemed Reseller tax laws in the EU and UK.
-     * @type {string}
-     * @memberof OrderItem
      */
     'DeemedResellerCategory'?: OrderItemDeemedResellerCategoryEnum;
-    /**
-     *
-     * @type {ItemBuyerInfo}
-     * @memberof OrderItem
-     */
     'BuyerInfo'?: ItemBuyerInfo;
-    /**
-     *
-     * @type {BuyerRequestedCancel}
-     * @memberof OrderItem
-     */
     'BuyerRequestedCancel'?: BuyerRequestedCancel;
     /**
      * A list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only.
-     * @type {Array<string>}
-     * @memberof OrderItem
      */
     'SerialNumbers'?: Array<string>;
-    /**
-     *
-     * @type {SubstitutionPreferences}
-     * @memberof OrderItem
-     */
     'SubstitutionPreferences'?: SubstitutionPreferences;
-    /**
-     *
-     * @type {Measurement}
-     * @memberof OrderItem
-     */
     'Measurement'?: Measurement;
-    /**
-     *
-     * @type {ShippingConstraints}
-     * @memberof OrderItem
-     */
     'ShippingConstraints'?: ShippingConstraints;
-    /**
-     *
-     * @type {AmazonPrograms}
-     * @memberof OrderItem
-     */
     'AmazonPrograms'?: AmazonPrograms;
-    /**
-     *
-     * @type {ExportInfo}
-     * @memberof OrderItem
-     */
-    'ExportInfo'?: ExportInfo;
 }
 export declare const OrderItemDeemedResellerCategoryEnum: {
     readonly Ioss: "IOSS";

package/dist/types/api-model/models/order-items-buyer-info-list.d.ts

@@ -12,26 +12,18 @@
 import type { OrderItemBuyerInfo } from './order-item-buyer-info';
 /**
  * A single order item\'s buyer information list with the order ID.
- * @export
- * @interface OrderItemsBuyerInfoList
  */
 export interface OrderItemsBuyerInfoList {
     /**
      * A single order item\'s buyer information list.
-     * @type {Array<OrderItemBuyerInfo>}
-     * @memberof OrderItemsBuyerInfoList
      */
     'OrderItems': Array<OrderItemBuyerInfo>;
     /**
      * When present and not empty, pass this string token in the next request to return the next response page.
-     * @type {string}
-     * @memberof OrderItemsBuyerInfoList
      */
     'NextToken'?: string;
     /**
      * An Amazon-defined order identifier, in 3-7-7 format.
-     * @type {string}
-     * @memberof OrderItemsBuyerInfoList
      */
     'AmazonOrderId': string;
 }

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

@@ -9,22 +9,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @interface OrderItemsInner
- */
 export interface OrderItemsInner {
     /**
      * The order item\'s unique identifier.
-     * @type {string}
-     * @memberof OrderItemsInner
      */
     'orderItemId'?: string;
     /**
      * The quantity for which to update the shipment status.
-     * @type {number}
-     * @memberof OrderItemsInner
      */
     'quantity'?: number;
 }

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

@@ -12,26 +12,18 @@
 import type { OrderItem } from './order-item';
 /**
  * The order items list along with the order ID.
- * @export
- * @interface OrderItemsList
  */
 export interface OrderItemsList {
     /**
      * A list of order items.
-     * @type {Array<OrderItem>}
-     * @memberof OrderItemsList
      */
     'OrderItems': Array<OrderItem>;
     /**
      * When present and not empty, pass this string token in the next request to return the next response page.
-     * @type {string}
-     * @memberof OrderItemsList
      */
     'NextToken'?: string;
     /**
      * An Amazon-defined order identifier, in 3-7-7 format.
-     * @type {string}
-     * @memberof OrderItemsList
      */
     'AmazonOrderId': string;
 }

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

@@ -13,32 +13,16 @@ import type { RegulatedInformation } from './regulated-information';
 import type { RegulatedOrderVerificationStatus } from './regulated-order-verification-status';
 /**
  * The order\'s regulated information along with its verification status.
- * @export
- * @interface OrderRegulatedInfo
  */
 export interface OrderRegulatedInfo {
     /**
      * An Amazon-defined order identifier, in 3-7-7 format.
-     * @type {string}
-     * @memberof OrderRegulatedInfo
      */
     'AmazonOrderId': string;
-    /**
-     *
-     * @type {RegulatedInformation}
-     * @memberof OrderRegulatedInfo
-     */
     'RegulatedInformation': RegulatedInformation;
     /**
      * When true, the order requires attaching a dosage information label when shipped.
-     * @type {boolean}
-     * @memberof OrderRegulatedInfo
      */
     'RequiresDosageLabel': boolean;
-    /**
-     *
-     * @type {RegulatedOrderVerificationStatus}
-     * @memberof OrderRegulatedInfo
-     */
     'RegulatedOrderVerificationStatus': RegulatedOrderVerificationStatus;
 }

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

@@ -21,291 +21,165 @@ import type { Money } from './money';
 import type { PaymentExecutionDetailItem } from './payment-execution-detail-item';
 /**
  * Order information.
- * @export
- * @interface Order
  */
 export interface Order {
     /**
      * An Amazon-defined order identifier, in 3-7-7 format.
-     * @type {string}
-     * @memberof Order
      */
     'AmazonOrderId': string;
     /**
      * A seller-defined order identifier.
-     * @type {string}
-     * @memberof Order
      */
     'SellerOrderId'?: string;
     /**
      * The date when the order was created.
-     * @type {string}
-     * @memberof Order
      */
     'PurchaseDate': string;
     /**
      * The date when the order was last updated.  __Note__: `LastUpdateDate` is returned with an incorrect date for orders that were last updated before 2009-04-01.
-     * @type {string}
-     * @memberof Order
      */
     'LastUpdateDate': string;
     /**
      * The current order status.
-     * @type {string}
-     * @memberof Order
      */
     'OrderStatus': OrderOrderStatusEnum;
     /**
      * Whether the order was fulfilled by Amazon (`AFN`) or by the seller (`MFN`).
-     * @type {string}
-     * @memberof Order
      */
     'FulfillmentChannel'?: OrderFulfillmentChannelEnum;
     /**
      * The sales channel for the first item in the order.
-     * @type {string}
-     * @memberof Order
      */
     'SalesChannel'?: string;
     /**
      * The order channel for the first item in the order.
-     * @type {string}
-     * @memberof Order
      */
     'OrderChannel'?: string;
     /**
      * The order\'s shipment service level.
-     * @type {string}
-     * @memberof Order
      */
     'ShipServiceLevel'?: string;
-    /**
-     *
-     * @type {Money}
-     * @memberof Order
-     */
     'OrderTotal'?: Money;
     /**
      * The number of items shipped.
-     * @type {number}
-     * @memberof Order
      */
     'NumberOfItemsShipped'?: number;
     /**
      * The number of items unshipped.
-     * @type {number}
-     * @memberof Order
      */
     'NumberOfItemsUnshipped'?: number;
     /**
      * A list of payment execution detail items.
-     * @type {Array<PaymentExecutionDetailItem>}
-     * @memberof Order
      */
     'PaymentExecutionDetail'?: Array<PaymentExecutionDetailItem>;
     /**
      * The payment method for the order. This property is limited to COD and CVS payment methods. Unless you need the specific COD payment information provided by the `PaymentExecutionDetailItem` object, we recommend using the `PaymentMethodDetails` property to get payment method information.
-     * @type {string}
-     * @memberof Order
      */
     'PaymentMethod'?: OrderPaymentMethodEnum;
     /**
      * A list of payment method detail items.
-     * @type {Array<string>}
-     * @memberof Order
      */
     'PaymentMethodDetails'?: Array<string>;
     /**
      * The identifier for the marketplace where the order was placed.
-     * @type {string}
-     * @memberof Order
      */
     'MarketplaceId'?: string;
     /**
      * The shipment service level category for the order.  **Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, and `Standard`.
-     * @type {string}
-     * @memberof Order
      */
     'ShipmentServiceLevelCategory'?: string;
-    /**
-     *
-     * @type {EasyShipShipmentStatus}
-     * @memberof Order
-     */
     'EasyShipShipmentStatus'?: EasyShipShipmentStatus;
     /**
      * Custom ship label for Checkout by Amazon (CBA).
-     * @type {string}
-     * @memberof Order
      */
     'CbaDisplayableShippingLabel'?: string;
     /**
      * The order\'s type.
-     * @type {string}
-     * @memberof Order
      */
     'OrderType'?: OrderOrderTypeEnum;
     /**
      * The start of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.  __Note__: `EarliestShipDate` might not be returned for orders placed before February 1, 2013.
-     * @type {string}
-     * @memberof Order
      */
     'EarliestShipDate'?: string;
     /**
      * The end of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.  __Note__: `LatestShipDate` might not be returned for orders placed before February 1, 2013.
-     * @type {string}
-     * @memberof Order
      */
     'LatestShipDate'?: string;
     /**
      * The start of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders.
-     * @type {string}
-     * @memberof Order
      */
     'EarliestDeliveryDate'?: string;
     /**
      * The end of the time period within which you have committed to fulfill the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned for seller-fulfilled orders that do not have a `PendingAvailability`, `Pending`, or `Canceled` status.
-     * @type {string}
-     * @memberof Order
      */
     'LatestDeliveryDate'?: string;
     /**
      * When true, the order is an Amazon Business order. An Amazon Business order is an order where the buyer is a Verified Business Buyer.
-     * @type {boolean}
-     * @memberof Order
      */
     'IsBusinessOrder'?: boolean;
     /**
      * When true, the order is a seller-fulfilled Amazon Prime order.
-     * @type {boolean}
-     * @memberof Order
      */
     'IsPrime'?: boolean;
     /**
      * When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, refer to \"Premium Shipping Options\" in the Seller Central Help for your marketplace.
-     * @type {boolean}
-     * @memberof Order
      */
     'IsPremiumOrder'?: boolean;
     /**
      * When true, the order is a `GlobalExpress` order.
-     * @type {boolean}
-     * @memberof Order
      */
     'IsGlobalExpressEnabled'?: boolean;
     /**
      * The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true.
-     * @type {string}
-     * @memberof Order
      */
     'ReplacedOrderId'?: string;
     /**
      * When true, this is a replacement order.
-     * @type {boolean}
-     * @memberof Order
      */
     'IsReplacementOrder'?: boolean;
     /**
      * Indicates the date by which the seller must respond to the buyer with an estimated ship date. Only returned for Sourcing on Demand orders.
-     * @type {string}
-     * @memberof Order
      */
     'PromiseResponseDueDate'?: string;
     /**
      * When true, the estimated ship date is set for the order. Only returned for Sourcing on Demand orders.
-     * @type {boolean}
-     * @memberof Order
      */
     'IsEstimatedShipDateSet'?: boolean;
     /**
      * When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller.
-     * @type {boolean}
-     * @memberof Order
      */
     'IsSoldByAB'?: boolean;
     /**
      * When true, the item within this order was bought and re-sold by Amazon Business EU SARL (ABEU). By buying and instantly re-selling your items, ABEU becomes the seller of record, making your inventory available for sale to customers who would not otherwise purchase from a third-party seller.
-     * @type {boolean}
-     * @memberof Order
      */
     'IsIBA'?: boolean;
-    /**
-     *
-     * @type {Address}
-     * @memberof Order
-     */
     'DefaultShipFromLocationAddress'?: Address;
     /**
      * The buyer\'s invoicing preference. Sellers can use this data to issue electronic invoices for orders in Turkey.  **Note**: This attribute is only available in the Turkey marketplace.
-     * @type {string}
-     * @memberof Order
      */
     'BuyerInvoicePreference'?: OrderBuyerInvoicePreferenceEnum;
-    /**
-     *
-     * @type {BuyerTaxInformation}
-     * @memberof Order
-     */
     'BuyerTaxInformation'?: BuyerTaxInformation;
-    /**
-     *
-     * @type {FulfillmentInstruction}
-     * @memberof Order
-     */
     'FulfillmentInstruction'?: FulfillmentInstruction;
     /**
      * When true, this order is marked to be picked up from a store rather than delivered.
-     * @type {boolean}
-     * @memberof Order
      */
     'IsISPU'?: boolean;
     /**
      * When true, this order is marked to be delivered to an Access Point. The access location is chosen by the customer. Access Points include Amazon Hub Lockers, Amazon Hub Counters, and pickup points operated by carriers.
-     * @type {boolean}
-     * @memberof Order
      */
     'IsAccessPointOrder'?: boolean;
-    /**
-     *
-     * @type {MarketplaceTaxInfo}
-     * @memberof Order
-     */
     'MarketplaceTaxInfo'?: MarketplaceTaxInfo;
     /**
      * The seller’s friendly name registered in the marketplace where the sale took place. Sellers can use this data to issue electronic invoices for orders in Brazil.  **Note**: This attribute is only available in the Brazil marketplace for the orders with `Pending` or `Unshipped` status.
-     * @type {string}
-     * @memberof Order
      */
     'SellerDisplayName'?: string;
-    /**
-     *
-     * @type {Address}
-     * @memberof Order
-     */
     'ShippingAddress'?: Address;
-    /**
-     *
-     * @type {BuyerInfo}
-     * @memberof Order
-     */
     'BuyerInfo'?: BuyerInfo;
-    /**
-     *
-     * @type {AutomatedShippingSettings}
-     * @memberof Order
-     */
     'AutomatedShippingSettings'?: AutomatedShippingSettings;
     /**
      * Whether the order contains regulated items which may require additional approval steps before being fulfilled.
-     * @type {boolean}
-     * @memberof Order
      */
     'HasRegulatedItems'?: boolean;
-    /**
-     *
-     * @type {ElectronicInvoiceStatus}
-     * @memberof Order
-     */
     'ElectronicInvoiceStatus'?: ElectronicInvoiceStatus;
 }
 export declare const OrderOrderStatusEnum: {