@sp-api-sdk/orders-api-v0 1.12.3 → 1.14.0

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

@@ -28,319 +28,310 @@ export interface Order {
      * @type {string}
      * @memberof Order
      */
-    AmazonOrderId: string;
+    'AmazonOrderId': string;
     /**
      * A seller-defined order identifier.
      * @type {string}
      * @memberof Order
      */
-    SellerOrderId?: string;
+    'SellerOrderId'?: string;
     /**
      * The date when the order was created.
      * @type {string}
      * @memberof Order
      */
-    PurchaseDate: string;
+    '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;
+    'LastUpdateDate': string;
     /**
      * The current order status.
      * @type {string}
      * @memberof Order
      */
-    OrderStatus: OrderOrderStatusEnum;
+    'OrderStatus': OrderOrderStatusEnum;
     /**
      * Whether the order was fulfilled by Amazon (AFN) or by the seller (MFN).
      * @type {string}
      * @memberof Order
      */
-    FulfillmentChannel?: OrderFulfillmentChannelEnum;
+    'FulfillmentChannel'?: OrderFulfillmentChannelEnum;
     /**
      * The sales channel of the first item in the order.
      * @type {string}
      * @memberof Order
      */
-    SalesChannel?: string;
+    'SalesChannel'?: string;
     /**
      * The order channel of the first item in the order.
      * @type {string}
      * @memberof Order
      */
-    OrderChannel?: string;
+    'OrderChannel'?: string;
     /**
      * The shipment service level of the order.
      * @type {string}
      * @memberof Order
      */
-    ShipServiceLevel?: string;
+    'ShipServiceLevel'?: string;
     /**
      *
      * @type {Money}
      * @memberof Order
      */
-    OrderTotal?: Money;
+    'OrderTotal'?: Money;
     /**
      * The number of items shipped.
      * @type {number}
      * @memberof Order
      */
-    NumberOfItemsShipped?: number;
+    'NumberOfItemsShipped'?: number;
     /**
      * The number of items unshipped.
      * @type {number}
      * @memberof Order
      */
-    NumberOfItemsUnshipped?: number;
+    'NumberOfItemsUnshipped'?: number;
     /**
      * A list of payment execution detail items.
      * @type {Array<PaymentExecutionDetailItem>}
      * @memberof Order
      */
-    PaymentExecutionDetail?: Array<PaymentExecutionDetailItem>;
+    'PaymentExecutionDetail'?: Array<PaymentExecutionDetailItem>;
     /**
      * The payment method for the order. This property is limited to Cash On Delivery (COD) and Convenience Store (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;
+    'PaymentMethod'?: OrderPaymentMethodEnum;
     /**
      * A list of payment method detail items.
      * @type {Array<string>}
      * @memberof Order
      */
-    PaymentMethodDetails?: Array<string>;
+    'PaymentMethodDetails'?: Array<string>;
     /**
      * The identifier for the marketplace where the order was placed.
      * @type {string}
      * @memberof Order
      */
-    MarketplaceId?: string;
+    'MarketplaceId'?: string;
     /**
      * The shipment service level category of the order.  Possible values: Expedited, FreeEconomy, NextDay, SameDay, SecondDay, Scheduled, Standard.
      * @type {string}
      * @memberof Order
      */
-    ShipmentServiceLevelCategory?: string;
+    'ShipmentServiceLevelCategory'?: string;
     /**
      * The status of the Amazon Easy Ship order. This property is included only for Amazon Easy Ship orders.  Possible values: PendingPickUp, LabelCanceled, PickedUp, OutForDelivery, Damaged, Delivered, RejectedByBuyer, Undeliverable, ReturnedToSeller, ReturningToSeller.
      * @type {string}
      * @memberof Order
      */
-    EasyShipShipmentStatus?: string;
+    'EasyShipShipmentStatus'?: string;
     /**
      * Custom ship label for Checkout by Amazon (CBA).
      * @type {string}
      * @memberof Order
      */
-    CbaDisplayableShippingLabel?: string;
+    'CbaDisplayableShippingLabel'?: string;
     /**
      * The type of the order.
      * @type {string}
      * @memberof Order
      */
-    OrderType?: OrderOrderTypeEnum;
+    'OrderType'?: OrderOrderTypeEnum;
     /**
      * The start of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.  Note: EarliestShipDate might not be returned for orders placed before February 1, 2013.
      * @type {string}
      * @memberof Order
      */
-    EarliestShipDate?: string;
+    'EarliestShipDate'?: string;
     /**
      * The end of the time period within which you have committed to ship the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.  Note: LatestShipDate might not be returned for orders placed before February 1, 2013.
      * @type {string}
      * @memberof Order
      */
-    LatestShipDate?: string;
+    'LatestShipDate'?: string;
     /**
      * The start of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders.
      * @type {string}
      * @memberof Order
      */
-    EarliestDeliveryDate?: string;
+    'EarliestDeliveryDate'?: string;
     /**
      * The end of the time period within which you have committed to fulfill the order. In ISO 8601 date time format. Returned only for seller-fulfilled orders that do not have a PendingAvailability, Pending, or Canceled status.
      * @type {string}
      * @memberof Order
      */
-    LatestDeliveryDate?: string;
+    '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;
+    'IsBusinessOrder'?: boolean;
     /**
      * When true, the order is a seller-fulfilled Amazon Prime order.
      * @type {boolean}
      * @memberof Order
      */
-    IsPrime?: boolean;
+    'IsPrime'?: boolean;
     /**
      * When true, the order has a Premium Shipping Service Level Agreement. For more information about Premium Shipping orders, see \"Premium Shipping Options\" in the Seller Central Help for your marketplace.
      * @type {boolean}
      * @memberof Order
      */
-    IsPremiumOrder?: boolean;
+    'IsPremiumOrder'?: boolean;
     /**
      * When true, the order is a GlobalExpress order.
      * @type {boolean}
      * @memberof Order
      */
-    IsGlobalExpressEnabled?: boolean;
+    'IsGlobalExpressEnabled'?: boolean;
     /**
      * The order ID value for the order that is being replaced. Returned only if IsReplacementOrder = true.
      * @type {string}
      * @memberof Order
      */
-    ReplacedOrderId?: string;
+    'ReplacedOrderId'?: string;
     /**
      * When true, this is a replacement order.
      * @type {boolean}
      * @memberof Order
      */
-    IsReplacementOrder?: boolean;
+    'IsReplacementOrder'?: boolean;
     /**
      * Indicates the date by which the seller must respond to the buyer with an estimated ship date. Returned only for Sourcing on Demand orders.
      * @type {string}
      * @memberof Order
      */
-    PromiseResponseDueDate?: string;
+    'PromiseResponseDueDate'?: string;
     /**
      * When true, the estimated ship date is set for the order. Returned only for Sourcing on Demand orders.
      * @type {boolean}
      * @memberof Order
      */
-    IsEstimatedShipDateSet?: boolean;
+    '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;
+    '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;
+    'IsIBA'?: boolean;
     /**
      *
      * @type {Address}
      * @memberof Order
      */
-    DefaultShipFromLocationAddress?: Address;
+    'DefaultShipFromLocationAddress'?: Address;
     /**
      * The buyer\'s invoicing preference. Available only in the TR marketplace.
      * @type {string}
      * @memberof Order
      */
-    BuyerInvoicePreference?: OrderBuyerInvoicePreferenceEnum;
+    'BuyerInvoicePreference'?: OrderBuyerInvoicePreferenceEnum;
     /**
      *
      * @type {BuyerTaxInformation}
      * @memberof Order
      */
-    BuyerTaxInformation?: BuyerTaxInformation;
+    'BuyerTaxInformation'?: BuyerTaxInformation;
     /**
      *
      * @type {FulfillmentInstruction}
      * @memberof Order
      */
-    FulfillmentInstruction?: FulfillmentInstruction;
+    'FulfillmentInstruction'?: FulfillmentInstruction;
     /**
      * When true, this order is marked to be picked up from a store rather than delivered.
      * @type {boolean}
      * @memberof Order
      */
-    IsISPU?: boolean;
+    '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;
+    'MarketplaceTaxInfo'?: MarketplaceTaxInfo;
     /**
      * The seller’s friendly name registered in the marketplace.
      * @type {string}
      * @memberof Order
      */
-    SellerDisplayName?: string;
+    'SellerDisplayName'?: string;
     /**
      *
      * @type {Address}
      * @memberof Order
      */
-    ShippingAddress?: Address;
+    'ShippingAddress'?: Address;
     /**
      *
      * @type {BuyerInfo}
      * @memberof Order
      */
-    BuyerInfo?: BuyerInfo;
+    'BuyerInfo'?: BuyerInfo;
     /**
      *
      * @type {AutomatedShippingSettings}
      * @memberof Order
      */
-    AutomatedShippingSettings?: AutomatedShippingSettings;
+    'AutomatedShippingSettings'?: AutomatedShippingSettings;
     /**
      * Whether the order contains regulated items which may require additional approval steps before being fulfilled.
      * @type {boolean}
      * @memberof Order
      */
-    HasRegulatedItems?: boolean;
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum OrderOrderStatusEnum {
-    Pending = "Pending",
-    Unshipped = "Unshipped",
-    PartiallyShipped = "PartiallyShipped",
-    Shipped = "Shipped",
-    Canceled = "Canceled",
-    Unfulfillable = "Unfulfillable",
-    InvoiceUnconfirmed = "InvoiceUnconfirmed",
-    PendingAvailability = "PendingAvailability"
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum OrderFulfillmentChannelEnum {
-    Mfn = "MFN",
-    Afn = "AFN"
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum OrderPaymentMethodEnum {
-    Cod = "COD",
-    Cvs = "CVS",
-    Other = "Other"
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum OrderOrderTypeEnum {
-    StandardOrder = "StandardOrder",
-    LongLeadTimeOrder = "LongLeadTimeOrder",
-    Preorder = "Preorder",
-    BackOrder = "BackOrder",
-    SourcingOnDemandOrder = "SourcingOnDemandOrder"
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum OrderBuyerInvoicePreferenceEnum {
-    Individual = "INDIVIDUAL",
-    Business = "BUSINESS"
+    'HasRegulatedItems'?: boolean;
 }
+export declare const OrderOrderStatusEnum: {
+    readonly Pending: "Pending";
+    readonly Unshipped: "Unshipped";
+    readonly PartiallyShipped: "PartiallyShipped";
+    readonly Shipped: "Shipped";
+    readonly Canceled: "Canceled";
+    readonly Unfulfillable: "Unfulfillable";
+    readonly InvoiceUnconfirmed: "InvoiceUnconfirmed";
+    readonly PendingAvailability: "PendingAvailability";
+};
+export declare type OrderOrderStatusEnum = typeof OrderOrderStatusEnum[keyof typeof OrderOrderStatusEnum];
+export declare const OrderFulfillmentChannelEnum: {
+    readonly Mfn: "MFN";
+    readonly Afn: "AFN";
+};
+export declare type OrderFulfillmentChannelEnum = typeof OrderFulfillmentChannelEnum[keyof typeof OrderFulfillmentChannelEnum];
+export declare const OrderPaymentMethodEnum: {
+    readonly Cod: "COD";
+    readonly Cvs: "CVS";
+    readonly Other: "Other";
+};
+export declare type OrderPaymentMethodEnum = typeof OrderPaymentMethodEnum[keyof typeof OrderPaymentMethodEnum];
+export declare const OrderOrderTypeEnum: {
+    readonly StandardOrder: "StandardOrder";
+    readonly LongLeadTimeOrder: "LongLeadTimeOrder";
+    readonly Preorder: "Preorder";
+    readonly BackOrder: "BackOrder";
+    readonly SourcingOnDemandOrder: "SourcingOnDemandOrder";
+};
+export declare type OrderOrderTypeEnum = typeof OrderOrderTypeEnum[keyof typeof OrderOrderTypeEnum];
+export declare const OrderBuyerInvoicePreferenceEnum: {
+    readonly Individual: "INDIVIDUAL";
+    readonly Business: "BUSINESS";
+};
+export declare type OrderBuyerInvoicePreferenceEnum = typeof OrderBuyerInvoicePreferenceEnum[keyof typeof OrderBuyerInvoicePreferenceEnum];

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

@@ -21,23 +21,23 @@ export interface OrdersList {
      * @type {Array<Order>}
      * @memberof OrdersList
      */
-    Orders: Array<Order>;
+    '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;
+    'NextToken'?: string;
     /**
      * A date used for selecting 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 format.
      * @type {string}
      * @memberof OrdersList
      */
-    LastUpdatedBefore?: string;
+    'LastUpdatedBefore'?: string;
     /**
      * A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
      * @type {string}
      * @memberof OrdersList
      */
-    CreatedBefore?: string;
+    'CreatedBefore'?: string;
 }

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

@@ -21,11 +21,11 @@ export interface PaymentExecutionDetailItem {
      * @type {Money}
      * @memberof PaymentExecutionDetailItem
      */
-    Payment: Money;
+    'Payment': Money;
     /**
      * A sub-payment method for a COD order.  Possible values:  * COD - Cash On Delivery.  * GC - Gift Card.  * PointsAccount - Amazon Points.
      * @type {string}
      * @memberof PaymentExecutionDetailItem
      */
-    PaymentMethod: string;
+    'PaymentMethod': string;
 }

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

@@ -21,11 +21,11 @@ export interface PointsGrantedDetail {
      * @type {number}
      * @memberof PointsGrantedDetail
      */
-    PointsNumber?: number;
+    'PointsNumber'?: number;
     /**
      *
      * @type {Money}
      * @memberof PointsGrantedDetail
      */
-    PointsMonetaryValue?: Money;
+    'PointsMonetaryValue'?: Money;
 }

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

@@ -20,5 +20,5 @@ export interface ProductInfoDetail {
      * @type {number}
      * @memberof ProductInfoDetail
      */
-    NumberOfItems?: number;
+    'NumberOfItems'?: number;
 }

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

@@ -20,31 +20,28 @@ export interface RegulatedInformationField {
      * @type {string}
      * @memberof RegulatedInformationField
      */
-    FieldId: string;
+    'FieldId': string;
     /**
      * The human-readable name for the field.
      * @type {string}
      * @memberof RegulatedInformationField
      */
-    FieldLabel: string;
+    'FieldLabel': string;
     /**
      * The type of field the field.
      * @type {string}
      * @memberof RegulatedInformationField
      */
-    FieldType: RegulatedInformationFieldFieldTypeEnum;
+    'FieldType': RegulatedInformationFieldFieldTypeEnum;
     /**
      * The content of the field as collected in regulatory form. Note that FileAttachment type fields will contain an URL to download the attachment here.
      * @type {string}
      * @memberof RegulatedInformationField
      */
-    FieldValue: string;
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum RegulatedInformationFieldFieldTypeEnum {
-    Text = "Text",
-    FileAttachment = "FileAttachment"
+    'FieldValue': string;
 }
+export declare const RegulatedInformationFieldFieldTypeEnum: {
+    readonly Text: "Text";
+    readonly FileAttachment: "FileAttachment";
+};
+export declare type RegulatedInformationFieldFieldTypeEnum = typeof RegulatedInformationFieldFieldTypeEnum[keyof typeof RegulatedInformationFieldFieldTypeEnum];

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

@@ -21,5 +21,5 @@ export interface RegulatedInformation {
      * @type {Array<RegulatedInformationField>}
      * @memberof RegulatedInformation
      */
-    Fields: Array<RegulatedInformationField>;
+    'Fields': Array<RegulatedInformationField>;
 }

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { RejectionReason } from './rejection-reason';
+import { VerificationStatus } from './verification-status';
 /**
  * The verification status of the order along with associated approval or rejection metadata.
  * @export
@@ -17,50 +18,39 @@ import { RejectionReason } from './rejection-reason';
  */
 export interface RegulatedOrderVerificationStatus {
     /**
-     * The verification status of the order.
-     * @type {string}
+     *
+     * @type {VerificationStatus}
      * @memberof RegulatedOrderVerificationStatus
      */
-    Status: RegulatedOrderVerificationStatusStatusEnum;
+    'Status': VerificationStatus;
     /**
      * Whether the regulated information provided in the order requires a review by the merchant.
      * @type {boolean}
      * @memberof RegulatedOrderVerificationStatus
      */
-    RequiresMerchantAction: boolean;
+    '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>;
+    'ValidRejectionReasons': Array<RejectionReason>;
     /**
      *
      * @type {RejectionReason}
      * @memberof RegulatedOrderVerificationStatus
      */
-    RejectionReason?: RejectionReason;
+    'RejectionReason'?: RejectionReason;
     /**
      * The date the order was reviewed. In ISO 8601 date time format.
      * @type {string}
      * @memberof RegulatedOrderVerificationStatus
      */
-    ReviewDate?: string;
+    'ReviewDate'?: string;
     /**
      * The identifier for the order\'s regulated information reviewer.
      * @type {string}
      * @memberof RegulatedOrderVerificationStatus
      */
-    ExternalReviewerId?: string;
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum RegulatedOrderVerificationStatusStatusEnum {
-    Pending = "Pending",
-    Approved = "Approved",
-    Rejected = "Rejected",
-    Expired = "Expired",
-    Cancelled = "Cancelled"
+    'ExternalReviewerId'?: string;
 }

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

@@ -20,11 +20,11 @@ export interface RejectionReason {
      * @type {string}
      * @memberof RejectionReason
      */
-    RejectionReasonId: string;
+    'RejectionReasonId': string;
     /**
      * The human-readable description of this rejection reason.
      * @type {string}
      * @memberof RejectionReason
      */
-    RejectionReasonDescription: string;
+    'RejectionReasonDescription': string;
 }

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

@@ -14,8 +14,9 @@
  * @export
  * @enum {string}
  */
-export declare enum ShipmentStatus {
-    ReadyForPickup = "ReadyForPickup",
-    PickedUp = "PickedUp",
-    RefusedPickup = "RefusedPickup"
-}
+export declare const ShipmentStatus: {
+    readonly ReadyForPickup: "ReadyForPickup";
+    readonly PickedUp: "PickedUp";
+    readonly RefusedPickup: "RefusedPickup";
+};
+export declare type ShipmentStatus = typeof ShipmentStatus[keyof typeof ShipmentStatus];

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

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

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

@@ -20,25 +20,19 @@ export interface TaxCollection {
      * @type {string}
      * @memberof TaxCollection
      */
-    Model?: TaxCollectionModelEnum;
+    'Model'?: TaxCollectionModelEnum;
     /**
      * The party responsible for withholding the taxes and remitting them to the taxing authority.
      * @type {string}
      * @memberof TaxCollection
      */
-    ResponsibleParty?: TaxCollectionResponsiblePartyEnum;
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum TaxCollectionModelEnum {
-    MarketplaceFacilitator = "MarketplaceFacilitator"
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum TaxCollectionResponsiblePartyEnum {
-    AmazonServicesInc = "Amazon Services, Inc."
+    'ResponsibleParty'?: TaxCollectionResponsiblePartyEnum;
 }
+export declare const TaxCollectionModelEnum: {
+    readonly MarketplaceFacilitator: "MarketplaceFacilitator";
+};
+export declare type TaxCollectionModelEnum = typeof TaxCollectionModelEnum[keyof typeof TaxCollectionModelEnum];
+export declare const TaxCollectionResponsiblePartyEnum: {
+    readonly AmazonServicesInc: "Amazon Services, Inc.";
+};
+export declare type TaxCollectionResponsiblePartyEnum = typeof TaxCollectionResponsiblePartyEnum[keyof typeof TaxCollectionResponsiblePartyEnum];