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

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: {

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

@@ -12,32 +12,22 @@
 import type { Order } from './order';
 /**
  * A list of orders along with additional information to make subsequent API calls.
- * @export
- * @interface OrdersList
  */
 export interface OrdersList {
     /**
      * A list of orders.
-     * @type {Array<Order>}
-     * @memberof OrdersList
      */
     'Orders': Array<Order>;
     /**
      * When present and not empty, pass this string token in the next request to return the next response page.
-     * @type {string}
-     * @memberof OrdersList
      */
     'NextToken'?: string;
     /**
      * Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. Use [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format for all dates.
-     * @type {string}
-     * @memberof OrdersList
      */
     'LastUpdatedBefore'?: string;
     /**
      * Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-     * @type {string}
-     * @memberof OrdersList
      */
     'CreatedBefore'?: string;
 }

package/dist/types/api-model/models/other-delivery-attributes.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Miscellaneous delivery attributes associated with the shipping address.
- * @export
- * @enum {string}
  */
 export declare const OtherDeliveryAttributes: {
     readonly HasAccessPoint: "HAS_ACCESS_POINT";

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

@@ -12,56 +12,38 @@
 import type { ConfirmShipmentOrderItem } from './confirm-shipment-order-item';
 /**
  * Properties of packages
- * @export
- * @interface PackageDetail
  */
 export interface PackageDetail {
     /**
      * A seller-supplied identifier that uniquely identifies a package within the scope of an order. Only positive numeric values are supported.
-     * @type {string}
-     * @memberof PackageDetail
      */
     'packageReferenceId': string;
     /**
      * Identifies the carrier that will deliver the package. This field is required for all marketplaces. For more information, refer to the [`CarrierCode` announcement](https://developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces).
-     * @type {string}
-     * @memberof PackageDetail
      */
     'carrierCode': string;
     /**
      * Carrier name that will deliver the package. Required when `carrierCode` is \"Other\"
-     * @type {string}
-     * @memberof PackageDetail
      */
     'carrierName'?: string;
     /**
      * Ship method to be used for shipping the order.
-     * @type {string}
-     * @memberof PackageDetail
      */
     'shippingMethod'?: string;
     /**
      * The tracking number used to obtain tracking and delivery information.
-     * @type {string}
-     * @memberof PackageDetail
      */
     'trackingNumber': string;
     /**
      * The shipping date for the package. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
-     * @type {string}
-     * @memberof PackageDetail
      */
     'shipDate': string;
     /**
      * The unique identifier for the supply source.
-     * @type {string}
-     * @memberof PackageDetail
      */
     'shipFromSupplySourceId'?: string;
     /**
      * A list of order items.
-     * @type {Array<ConfirmShipmentOrderItem>}
-     * @memberof PackageDetail
      */
     'orderItems': Array<ConfirmShipmentOrderItem>;
 }

package/dist/types/api-model/models/payment-execution-detail-item.d.ts

@@ -12,20 +12,11 @@
 import type { Money } from './money';
 /**
  * Information about a sub-payment method used to pay for a COD order.
- * @export
- * @interface PaymentExecutionDetailItem
  */
 export interface PaymentExecutionDetailItem {
-    /**
-     *
-     * @type {Money}
-     * @memberof PaymentExecutionDetailItem
-     */
     'Payment': Money;
     /**
      * A sub-payment method for a COD order.  **Possible values**: * `COD`: Cash on delivery  * `GC`: Gift card  * `PointsAccount`: Amazon Points * `Invoice`: Invoice
-     * @type {string}
-     * @memberof PaymentExecutionDetailItem
      */
     'PaymentMethod': string;
 }

package/dist/types/api-model/models/points-granted-detail.d.ts

@@ -12,20 +12,11 @@
 import type { Money } from './money';
 /**
  * The number of Amazon Points offered with the purchase of an item, and their monetary value.
- * @export
- * @interface PointsGrantedDetail
  */
 export interface PointsGrantedDetail {
     /**
      * The number of Amazon Points granted with the purchase of an item.
-     * @type {number}
-     * @memberof PointsGrantedDetail
      */
     'PointsNumber'?: number;
-    /**
-     *
-     * @type {Money}
-     * @memberof PointsGrantedDetail
-     */
     'PointsMonetaryValue'?: Money;
 }

package/dist/types/api-model/models/preferred-delivery-time.d.ts

@@ -13,20 +13,14 @@ import type { BusinessHours } from './business-hours';
 import type { ExceptionDates } from './exception-dates';
 /**
  * The time window when the delivery is preferred.
- * @export
- * @interface PreferredDeliveryTime
  */
 export interface PreferredDeliveryTime {
     /**
      * Business hours when the business is open for deliveries.
-     * @type {Array<BusinessHours>}
-     * @memberof PreferredDeliveryTime
      */
     'BusinessHours'?: Array<BusinessHours>;
     /**
      * Dates when the business is closed during the next 30 days.
-     * @type {Array<ExceptionDates>}
-     * @memberof PreferredDeliveryTime
      */
     'ExceptionDates'?: Array<ExceptionDates>;
 }

package/dist/types/api-model/models/prescription-detail.d.ts

@@ -11,50 +11,34 @@
  */
 /**
  * Information about the prescription that is used to verify a regulated product. This must be provided once per order and reflect the seller’s own records. Only approved orders can have prescriptions.
- * @export
- * @interface PrescriptionDetail
  */
 export interface PrescriptionDetail {
     /**
      * The identifier for the prescription used to verify the regulated product.
-     * @type {string}
-     * @memberof PrescriptionDetail
      */
     'prescriptionId': string;
     /**
      * The expiration date of the prescription used to verify the regulated product, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
-     * @type {string}
-     * @memberof PrescriptionDetail
      */
     'expirationDate': string;
     /**
      * The number of units in each fill as provided in the prescription.
-     * @type {number}
-     * @memberof PrescriptionDetail
      */
     'writtenQuantity': number;
     /**
      * The total number of refills written in the original prescription used to verify the regulated product. If a prescription originally had no refills, this value must be 0.
-     * @type {number}
-     * @memberof PrescriptionDetail
      */
     'totalRefillsAuthorized': number;
     /**
      * The number of refills remaining for the prescription used to verify the regulated product. If a prescription originally had 10 total refills, this value must be `10` for the first order, `9` for the second order, and `0` for the eleventh order. If a prescription originally had no refills, this value must be 0.
-     * @type {number}
-     * @memberof PrescriptionDetail
      */
     'refillsRemaining': number;
     /**
      * The identifier for the clinic which provided the prescription used to verify the regulated product.
-     * @type {string}
-     * @memberof PrescriptionDetail
      */
     'clinicId': string;
     /**
      * The instructions for the prescription as provided by the approver of the regulated product.
-     * @type {string}
-     * @memberof PrescriptionDetail
      */
     'usageInstructions': string;
 }

package/dist/types/api-model/models/product-info-detail.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * Product information on the number of items.
- * @export
- * @interface ProductInfoDetail
  */
 export interface ProductInfoDetail {
     /**
      * The total number of items that are included in the ASIN.
-     * @type {string}
-     * @memberof ProductInfoDetail
      */
     'NumberOfItems'?: string;
 }

package/dist/types/api-model/models/regulated-information-field.d.ts

@@ -11,32 +11,22 @@
  */
 /**
  * A field collected from the regulatory form.
- * @export
- * @interface RegulatedInformationField
  */
 export interface RegulatedInformationField {
     /**
      * The unique identifier of the field.
-     * @type {string}
-     * @memberof RegulatedInformationField
      */
     'FieldId': string;
     /**
      * The name of the field.
-     * @type {string}
-     * @memberof RegulatedInformationField
      */
     'FieldLabel': string;
     /**
      * The type of field.
-     * @type {string}
-     * @memberof RegulatedInformationField
      */
     'FieldType': RegulatedInformationFieldFieldTypeEnum;
     /**
      * The content of the field as collected in regulatory form. Note that `FileAttachment` type fields contain a URL where you can download the attachment.
-     * @type {string}
-     * @memberof RegulatedInformationField
      */
     'FieldValue': string;
 }

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

@@ -12,14 +12,10 @@
 import type { RegulatedInformationField } from './regulated-information-field';
 /**
  * The regulated information collected during purchase and used to verify the order.
- * @export
- * @interface RegulatedInformation
  */
 export interface RegulatedInformation {
     /**
      * A list of regulated information fields as collected from the regulatory form.
-     * @type {Array<RegulatedInformationField>}
-     * @memberof RegulatedInformation
      */
     'Fields': Array<RegulatedInformationField>;
 }

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

@@ -14,50 +14,28 @@ import type { ValidVerificationDetail } from './valid-verification-detail';
 import type { VerificationStatus } from './verification-status';
 /**
  * The verification status of the order, along with associated approval or rejection metadata.
- * @export
- * @interface RegulatedOrderVerificationStatus
  */
 export interface RegulatedOrderVerificationStatus {
-    /**
-     *
-     * @type {VerificationStatus}
-     * @memberof RegulatedOrderVerificationStatus
-     */
     'Status': VerificationStatus;
     /**
      * When true, the regulated information provided in the order requires a review by the merchant.
-     * @type {boolean}
-     * @memberof RegulatedOrderVerificationStatus
      */
     'RequiresMerchantAction': boolean;
     /**
      * A list of valid rejection reasons that may be used to reject the order\'s regulated information.
-     * @type {Array<RejectionReason>}
-     * @memberof RegulatedOrderVerificationStatus
      */
     'ValidRejectionReasons': Array<RejectionReason>;
-    /**
-     *
-     * @type {RejectionReason}
-     * @memberof RegulatedOrderVerificationStatus
-     */
     'RejectionReason'?: RejectionReason;
     /**
      * The date the order was reviewed. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
-     * @type {string}
-     * @memberof RegulatedOrderVerificationStatus
      */
     'ReviewDate'?: string;
     /**
      * The identifier for the order\'s regulated information reviewer.
-     * @type {string}
-     * @memberof RegulatedOrderVerificationStatus
      */
     'ExternalReviewerId'?: string;
     /**
      * A list of valid verification details that may be provided and the criteria required for when the verification detail can be provided.
-     * @type {Array<ValidVerificationDetail>}
-     * @memberof RegulatedOrderVerificationStatus
      */
     'ValidVerificationDetails'?: Array<ValidVerificationDetail>;
 }

package/dist/types/api-model/models/rejection-reason.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The reason for rejecting the order\'s regulated information. This is only present if the order is rejected.
- * @export
- * @interface RejectionReason
  */
 export interface RejectionReason {
     /**
      * The unique identifier for the rejection reason.
-     * @type {string}
-     * @memberof RejectionReason
      */
     'RejectionReasonId': string;
     /**
      * The description of this rejection reason.
-     * @type {string}
-     * @memberof RejectionReason
      */
     'RejectionReasonDescription': string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The shipment status to apply.
- * @export
- * @enum {string}
  */
 export declare const ShipmentStatus: {
     readonly ReadyForPickup: "ReadyForPickup";