@sp-api-sdk/orders-api-v0 1.8.5

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

@@ -0,0 +1,56 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { BuyerCustomizedInfoDetail } from './buyer-customized-info-detail';
+import { 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.
+     * @type {string}
+     * @memberof OrderItemBuyerInfo
+     */
+    GiftMessageText?: string;
+    /**
+     * The gift wrap level specified by the buyer.
+     * @type {string}
+     * @memberof OrderItemBuyerInfo
+     */
+    GiftWrapLevel?: string;
+}

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

@@ -0,0 +1,229 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ItemBuyerInfo } from './item-buyer-info';
+import { Money } from './money';
+import { PointsGrantedDetail } from './points-granted-detail';
+import { ProductInfoDetail } from './product-info-detail';
+import { TaxCollection } from './tax-collection';
+/**
+ * A single order item.
+ * @export
+ * @interface OrderItem
+ */
+export interface OrderItem {
+    /**
+     * The Amazon Standard Identification Number (ASIN) of the item.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    ASIN: string;
+    /**
+     * The seller stock keeping unit (SKU) of the item.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    SellerSKU?: string;
+    /**
+     * An Amazon-defined order item identifier.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    OrderItemId: string;
+    /**
+     * The name of the item.
+     * @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;
+    /**
+     * When true, the item is a gift.
+     * @type {boolean}
+     * @memberof OrderItem
+     */
+    IsGift?: boolean;
+    /**
+     * 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, 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, Other.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    ConditionSubtypeId?: string;
+    /**
+     * The start date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    ScheduledDeliveryStartDate?: string;
+    /**
+     * The end date of the scheduled delivery window in the time zone of the order destination. In ISO 8601 date time format.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    ScheduledDeliveryEndDate?: string;
+    /**
+     * Indicates that the selling price is a special price that is available only for Amazon Business orders. For more information about the Amazon Business Seller Program, see the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business).   Possible values: BusinessPrice - A special price that is available only for Amazon Business orders.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    PriceDesignation?: string;
+    /**
+     *
+     * @type {TaxCollection}
+     * @memberof OrderItem
+     */
+    TaxCollection?: TaxCollection;
+    /**
+     * When true, the product type for this item has a serial number.  Returned only for Amazon Easy Ship orders.
+     * @type {boolean}
+     * @memberof OrderItem
+     */
+    SerialNumberRequired?: boolean;
+    /**
+     * When true, transparency codes are required.
+     * @type {boolean}
+     * @memberof OrderItem
+     */
+    IsTransparency?: boolean;
+    /**
+     * The IOSS number for the marketplace. Sellers shipping to the European Union (EU) from outside of 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;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+export declare enum OrderItemDeemedResellerCategoryEnum {
+    Ioss = "IOSS",
+    Uoss = "UOSS"
+}

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

@@ -0,0 +1,37 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { 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/src/api-model/models/order-items-list.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { 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/src/api-model/models/order.d.ts

@@ -0,0 +1,306 @@
+/**
+ * Selling Partner API for Orders
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Address } from './address';
+import { BuyerInfo } from './buyer-info';
+import { FulfillmentInstruction } from './fulfillment-instruction';
+import { MarketplaceTaxInfo } from './marketplace-tax-info';
+import { Money } from './money';
+import { 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 of the first item in the order.
+     * @type {string}
+     * @memberof Order
+     */
+    SalesChannel?: string;
+    /**
+     * The order channel of the first item in the order.
+     * @type {string}
+     * @memberof Order
+     */
+    OrderChannel?: string;
+    /**
+     * The shipment service level of the order.
+     * @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 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;
+    /**
+     * 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 of the order.  Possible values: Expedited, FreeEconomy, NextDay, SameDay, SecondDay, Scheduled, Standard.
+     * @type {string}
+     * @memberof Order
+     */
+    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;
+    /**
+     * Custom ship label for Checkout by Amazon (CBA).
+     * @type {string}
+     * @memberof Order
+     */
+    CbaDisplayableShippingLabel?: string;
+    /**
+     * The type of the order.
+     * @type {string}
+     * @memberof Order
+     */
+    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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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, see \"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. Returned only for Sourcing on Demand orders.
+     * @type {string}
+     * @memberof Order
+     */
+    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;
+    /**
+     * 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;
+    /**
+     *
+     * @type {Address}
+     * @memberof Order
+     */
+    DefaultShipFromLocationAddress?: Address;
+    /**
+     *
+     * @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;
+    /**
+     *
+     * @type {MarketplaceTaxInfo}
+     * @memberof Order
+     */
+    MarketplaceTaxInfo?: MarketplaceTaxInfo;
+    /**
+     * The seller’s friendly name registered in the marketplace.
+     * @type {string}
+     * @memberof Order
+     */
+    SellerDisplayName?: string;
+    /**
+     *
+     * @type {Address}
+     * @memberof Order
+     */
+    ShippingAddress?: Address;
+    /**
+     *
+     * @type {BuyerInfo}
+     * @memberof Order
+     */
+    BuyerInfo?: BuyerInfo;
+}
+/**
+    * @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"
+}