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

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. All dates must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-     * @type {string}
-     * @memberof OrdersList
+     * 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.
      */
     '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 \"Others\"
-     * @type {string}
-     * @memberof PackageDetail
+     * Carrier name that will deliver the package. Required when `carrierCode` is \"Other\"
      */
     '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";

package/dist/types/api-model/models/shipping-constraints.d.ts

@@ -12,32 +12,10 @@
 import type { ConstraintType } from './constraint-type';
 /**
  * Delivery constraints applicable to this order.
- * @export
- * @interface ShippingConstraints
  */
 export interface ShippingConstraints {
-    /**
-     *
-     * @type {ConstraintType}
-     * @memberof ShippingConstraints
-     */
     'PalletDelivery'?: ConstraintType;
-    /**
-     *
-     * @type {ConstraintType}
-     * @memberof ShippingConstraints
-     */
     'SignatureConfirmation'?: ConstraintType;
-    /**
-     *
-     * @type {ConstraintType}
-     * @memberof ShippingConstraints
-     */
     'RecipientIdentityVerification'?: ConstraintType;
-    /**
-     *
-     * @type {ConstraintType}
-     * @memberof ShippingConstraints
-     */
     'RecipientAgeVerification'?: ConstraintType;
 }

package/dist/types/api-model/models/substitution-option.d.ts

@@ -12,38 +12,23 @@
 import type { Measurement } from './measurement';
 /**
  * Substitution options for an order item.
- * @export
- * @interface SubstitutionOption
  */
 export interface SubstitutionOption {
     /**
      * The item\'s Amazon Standard Identification Number (ASIN).
-     * @type {string}
-     * @memberof SubstitutionOption
      */
     'ASIN'?: string;
     /**
      * The number of items to be picked for this substitution option.
-     * @type {number}
-     * @memberof SubstitutionOption
      */
     'QuantityOrdered'?: number;
     /**
      * The item\'s seller stock keeping unit (SKU).
-     * @type {string}
-     * @memberof SubstitutionOption
      */
     'SellerSKU'?: string;
     /**
      * The item\'s title.
-     * @type {string}
-     * @memberof SubstitutionOption
      */
     'Title'?: string;
-    /**
-     *
-     * @type {Measurement}
-     * @memberof SubstitutionOption
-     */
     'Measurement'?: Measurement;
 }

package/dist/types/api-model/models/substitution-preferences.d.ts

@@ -12,20 +12,14 @@
 import type { SubstitutionOption } from './substitution-option';
 /**
  * Substitution preferences for an order item.
- * @export
- * @interface SubstitutionPreferences
  */
 export interface SubstitutionPreferences {
     /**
      * The type of substitution that these preferences represent.
-     * @type {string}
-     * @memberof SubstitutionPreferences
      */
     'SubstitutionType': SubstitutionPreferencesSubstitutionTypeEnum;
     /**
      * A collection of substitution options.
-     * @type {Array<SubstitutionOption>}
-     * @memberof SubstitutionPreferences
      */
     'SubstitutionOptions'?: Array<SubstitutionOption>;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * The tax classification of the order.
- * @export
- * @interface TaxClassification
  */
 export interface TaxClassification {
     /**
      * The type of tax.
-     * @type {string}
-     * @memberof TaxClassification
      */
     'Name'?: string;
     /**
      * The buyer\'s tax identifier.
-     * @type {string}
-     * @memberof TaxClassification
      */
     'Value'?: string;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Information about withheld taxes.
- * @export
- * @interface TaxCollection
  */
 export interface TaxCollection {
     /**
      * The tax collection model applied to the item.
-     * @type {string}
-     * @memberof TaxCollection
      */
     'Model'?: TaxCollectionModelEnum;
     /**
      * The party responsible for withholding the taxes and remitting them to the taxing authority.
-     * @type {string}
-     * @memberof TaxCollection
      */
     'ResponsibleParty'?: TaxCollectionResponsiblePartyEnum;
 }

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

@@ -11,14 +11,10 @@
  */
 /**
  * The error response schema for the `UpdateShipmentStatus` operation.
- * @export
- * @interface UpdateShipmentStatusErrorResponse
  */
 export interface UpdateShipmentStatusErrorResponse {
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof UpdateShipmentStatusErrorResponse
      */
     'errors'?: Array<Error>;
 }

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

@@ -13,26 +13,15 @@ import type { OrderItemsInner } from './order-items-inner';
 import type { ShipmentStatus } from './shipment-status';
 /**
  * The request body for the `updateShipmentStatus` operation.
- * @export
- * @interface UpdateShipmentStatusRequest
  */
 export interface UpdateShipmentStatusRequest {
     /**
      * The unobfuscated marketplace identifier.
-     * @type {string}
-     * @memberof UpdateShipmentStatusRequest
      */
     'marketplaceId': string;
-    /**
-     *
-     * @type {ShipmentStatus}
-     * @memberof UpdateShipmentStatusRequest
-     */
     'shipmentStatus': ShipmentStatus;
     /**
      * For partial shipment status updates, the list of order items and quantities to be updated.
-     * @type {Array<OrderItemsInner>}
-     * @memberof UpdateShipmentStatusRequest
      */
     'orderItems'?: Array<OrderItemsInner>;
 }

package/dist/types/api-model/models/update-verification-status-error-response.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * The error response schema for the `UpdateVerificationStatus` operation.
- * @export
- * @interface UpdateVerificationStatusErrorResponse
  */
 export interface UpdateVerificationStatusErrorResponse {
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof UpdateVerificationStatusErrorResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/update-verification-status-request-body.d.ts

@@ -13,32 +13,16 @@ import type { VerificationDetails } from './verification-details';
 import type { VerificationStatus } from './verification-status';
 /**
  * The updated values of the `VerificationStatus` field.
- * @export
- * @interface UpdateVerificationStatusRequestBody
  */
 export interface UpdateVerificationStatusRequestBody {
-    /**
-     *
-     * @type {VerificationStatus}
-     * @memberof UpdateVerificationStatusRequestBody
-     */
     'status'?: VerificationStatus;
     /**
      * The identifier of the order\'s regulated information reviewer.
-     * @type {string}
-     * @memberof UpdateVerificationStatusRequestBody
      */
     'externalReviewerId': string;
     /**
      * The unique identifier of the rejection reason used for rejecting the order\'s regulated information. Only required if the new status is rejected.
-     * @type {string}
-     * @memberof UpdateVerificationStatusRequestBody
      */
     'rejectionReasonId'?: string;
-    /**
-     *
-     * @type {VerificationDetails}
-     * @memberof UpdateVerificationStatusRequestBody
-     */
     'verificationDetails'?: VerificationDetails;
 }

package/dist/types/api-model/models/update-verification-status-request.d.ts

@@ -12,14 +12,7 @@
 import type { UpdateVerificationStatusRequestBody } from './update-verification-status-request-body';
 /**
  * The request body for the `updateVerificationStatus` operation.
- * @export
- * @interface UpdateVerificationStatusRequest
  */
 export interface UpdateVerificationStatusRequest {
-    /**
-     *
-     * @type {UpdateVerificationStatusRequestBody}
-     * @memberof UpdateVerificationStatusRequest
-     */
     'regulatedOrderVerificationStatus': UpdateVerificationStatusRequestBody;
 }

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

@@ -12,20 +12,14 @@
 import type { VerificationStatus } from './verification-status';
 /**
  * The types of verification details that may be provided for the order and the criteria required for when the type of verification detail can be provided. The types of verification details allowed depend on the type of regulated product and will not change order to order.
- * @export
- * @interface ValidVerificationDetail
  */
 export interface ValidVerificationDetail {
     /**
      * A supported type of verification detail. The type indicates which verification detail could be shared while updating the regulated order. Valid value: `prescriptionDetail`.
-     * @type {string}
-     * @memberof ValidVerificationDetail
      */
     'VerificationDetailType': string;
     /**
      * A list of valid verification statuses where the associated verification detail type may be provided. For example, if the value of this field is [\"Approved\"], calls to provide the associated verification detail will fail for orders with a `VerificationStatus` of `Pending`, `Rejected`, `Expired`, or `Cancelled`.
-     * @type {Array<VerificationStatus>}
-     * @memberof ValidVerificationDetail
      */
     'ValidVerificationStatuses': Array<VerificationStatus>;
 }

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

@@ -12,14 +12,7 @@
 import type { PrescriptionDetail } from './prescription-detail';
 /**
  * Additional information related to the verification of a regulated order.
- * @export
- * @interface VerificationDetails
  */
 export interface VerificationDetails {
-    /**
-     *
-     * @type {PrescriptionDetail}
-     * @memberof VerificationDetails
-     */
     'prescriptionDetail'?: PrescriptionDetail;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The verification status of the order.
- * @export
- * @enum {string}
  */
 export declare const VerificationStatus: {
     readonly Pending: "Pending";