@sp-api-sdk/orders-api-v0 5.1.0 → 5.1.2

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

@@ -13,38 +13,17 @@ import type { BuyerCustomizedInfoDetail } from './buyer-customized-info-detail';
 import type { Money } from './money';
 /**
  * A single item\'s buyer information.
- * @export
- * @interface ItemBuyerInfo
  */
 export interface ItemBuyerInfo {
-    /**
-     *
-     * @type {BuyerCustomizedInfoDetail}
-     * @memberof ItemBuyerInfo
-     */
     'BuyerCustomizedInfo'?: BuyerCustomizedInfoDetail;
-    /**
-     *
-     * @type {Money}
-     * @memberof ItemBuyerInfo
-     */
     'GiftWrapPrice'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof ItemBuyerInfo
-     */
     'GiftWrapTax'?: Money;
     /**
      * A gift message provided by the buyer.  **Note**: This attribute is only available for MFN (fulfilled by seller) orders.
-     * @type {string}
-     * @memberof ItemBuyerInfo
      */
     'GiftMessageText'?: string;
     /**
      * The gift wrap level specified by the buyer.
-     * @type {string}
-     * @memberof ItemBuyerInfo
      */
     'GiftWrapLevel'?: string;
 }

package/dist/types/api-model/models/marketplace-tax-info.d.ts

@@ -12,14 +12,10 @@
 import type { TaxClassification } from './tax-classification';
 /**
  * Tax information about the marketplace.
- * @export
- * @interface MarketplaceTaxInfo
  */
 export interface MarketplaceTaxInfo {
     /**
      * A list of tax classifications that apply to the order.
-     * @type {Array<TaxClassification>}
-     * @memberof MarketplaceTaxInfo
      */
     'TaxClassifications'?: Array<TaxClassification>;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Measurement information for an order item.
- * @export
- * @interface Measurement
  */
 export interface Measurement {
     /**
      * The unit of measure.
-     * @type {string}
-     * @memberof Measurement
      */
     'Unit': MeasurementUnitEnum;
     /**
      * The measurement value.
-     * @type {number}
-     * @memberof Measurement
      */
     'Value': number;
 }

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

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

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

@@ -11,20 +11,14 @@
  */
 /**
  * The monetary value of the order.
- * @export
- * @interface Money
  */
 export interface Money {
     /**
      * The three-digit currency code. In ISO 4217 format.
-     * @type {string}
-     * @memberof Money
      */
     'CurrencyCode'?: string;
     /**
      * The currency amount.
-     * @type {string}
-     * @memberof Money
      */
     'Amount'?: string;
 }

package/dist/types/api-model/models/open-interval.d.ts

@@ -12,20 +12,8 @@
 import type { OpenTimeInterval } from './open-time-interval';
 /**
  * The time interval for which the business is open.
- * @export
- * @interface OpenInterval
  */
 export interface OpenInterval {
-    /**
-     *
-     * @type {OpenTimeInterval}
-     * @memberof OpenInterval
-     */
     'StartTime'?: OpenTimeInterval;
-    /**
-     *
-     * @type {OpenTimeInterval}
-     * @memberof OpenInterval
-     */
     'EndTime'?: OpenTimeInterval;
 }

package/dist/types/api-model/models/open-time-interval.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The time when the business opens or closes.
- * @export
- * @interface OpenTimeInterval
  */
 export interface OpenTimeInterval {
     /**
      * The hour when the business opens or closes.
-     * @type {number}
-     * @memberof OpenTimeInterval
      */
     'Hour'?: number;
     /**
      * The minute when the business opens or closes.
-     * @type {number}
-     * @memberof OpenTimeInterval
      */
     'Minute'?: number;
 }

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

@@ -13,32 +13,16 @@ import type { Address } from './address';
 import type { DeliveryPreferences } from './delivery-preferences';
 /**
  * The shipping address for the order.
- * @export
- * @interface OrderAddress
  */
 export interface OrderAddress {
     /**
      * An Amazon-defined order identifier, in 3-7-7 format.
-     * @type {string}
-     * @memberof OrderAddress
      */
     'AmazonOrderId': string;
     /**
      * The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities.
-     * @type {string}
-     * @memberof OrderAddress
      */
     'BuyerCompanyName'?: string;
-    /**
-     *
-     * @type {Address}
-     * @memberof OrderAddress
-     */
     'ShippingAddress'?: Address;
-    /**
-     *
-     * @type {DeliveryPreferences}
-     * @memberof OrderAddress
-     */
     'DeliveryPreferences'?: DeliveryPreferences;
 }

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

@@ -12,44 +12,27 @@
 import type { BuyerTaxInfo } from './buyer-tax-info';
 /**
  * Buyer information for an order.
- * @export
- * @interface OrderBuyerInfo
  */
 export interface OrderBuyerInfo {
     /**
      * An Amazon-defined order identifier, in 3-7-7 format.
-     * @type {string}
-     * @memberof OrderBuyerInfo
      */
     'AmazonOrderId': string;
     /**
      * The anonymized email address of the buyer.
-     * @type {string}
-     * @memberof OrderBuyerInfo
      */
     'BuyerEmail'?: string;
     /**
      * The buyer name or the recipient name.
-     * @type {string}
-     * @memberof OrderBuyerInfo
      */
     'BuyerName'?: string;
     /**
      * The county of the buyer.  **Note**: This attribute is only available in the Brazil marketplace.
-     * @type {string}
-     * @memberof OrderBuyerInfo
      */
     'BuyerCounty'?: string;
-    /**
-     *
-     * @type {BuyerTaxInfo}
-     * @memberof OrderBuyerInfo
-     */
     'BuyerTaxInfo'?: BuyerTaxInfo;
     /**
      * The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.
-     * @type {string}
-     * @memberof OrderBuyerInfo
      */
     'PurchaseOrderNumber'?: string;
 }

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

@@ -13,44 +13,21 @@ import type { BuyerCustomizedInfoDetail } from './buyer-customized-info-detail';
 import type { Money } from './money';
 /**
  * A single order item\'s buyer information.
- * @export
- * @interface OrderItemBuyerInfo
  */
 export interface OrderItemBuyerInfo {
     /**
      * An Amazon-defined order item identifier.
-     * @type {string}
-     * @memberof OrderItemBuyerInfo
      */
     'OrderItemId': string;
-    /**
-     *
-     * @type {BuyerCustomizedInfoDetail}
-     * @memberof OrderItemBuyerInfo
-     */
     'BuyerCustomizedInfo'?: BuyerCustomizedInfoDetail;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItemBuyerInfo
-     */
     'GiftWrapPrice'?: Money;
-    /**
-     *
-     * @type {Money}
-     * @memberof OrderItemBuyerInfo
-     */
     'GiftWrapTax'?: Money;
     /**
      * A gift message provided by the buyer.  **Note**: This attribute is only available for MFN (fulfilled by seller) orders.
-     * @type {string}
-     * @memberof OrderItemBuyerInfo
      */
     'GiftMessageText'?: string;
     /**
      * The gift wrap level specified by the buyer.
-     * @type {string}
-     * @memberof OrderItemBuyerInfo
      */
     'GiftWrapLevel'?: string;
 }

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

@@ -22,249 +22,110 @@ 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;
 }
 export declare const OrderItemDeemedResellerCategoryEnum: {

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;
 }