@sp-api-sdk/orders-api-2026-01-01 0.0.0 → 1.1.1

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

@@ -0,0 +1,29 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { DateTimeRange } from './date-time-range';
+import type { FulfillmentStatus } from './fulfillment-status';
+/**
+ * Information about how the order is being processed, packed, and shipped to the customer.
+ */
+export interface OrderFulfillment {
+    'fulfillmentStatus': FulfillmentStatus;
+    /**
+     * Specifies whether Amazon or the merchant is responsible for fulfilling this order.  **Possible values**: `AMAZON`, `MERCHANT`.
+     */
+    'fulfilledBy'?: string;
+    /**
+     * The category of the shipping speed option selected by the customer at checkout.  **Possible values**: `EXPEDITED`, `FREE_ECONOMY`, `NEXT_DAY`, `PRIORITY`, `SAME_DAY`, `SECOND_DAY`, `SCHEDULED`, `STANDARD`.
+     */
+    'fulfillmentServiceLevel'?: string;
+    'shipByWindow'?: DateTimeRange;
+    'deliverByWindow'?: DateTimeRange;
+}

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

@@ -0,0 +1,42 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ItemCancellation } from './item-cancellation';
+import type { ItemExpense } from './item-expense';
+import type { ItemFulfillment } from './item-fulfillment';
+import type { ItemProceeds } from './item-proceeds';
+import type { ItemProduct } from './item-product';
+import type { ItemPromotion } from './item-promotion';
+import type { Measurement } from './measurement';
+/**
+ * Information about a single product within an order.
+ */
+export interface OrderItem {
+    /**
+     * A unique identifier for this specific item within the order.
+     */
+    'orderItemId': string;
+    /**
+     * The number of units of this item that the customer ordered.
+     */
+    'quantityOrdered': number;
+    'measurement'?: Measurement;
+    /**
+     * Special programs that apply specifically to this item within the order.  **Possible values**: `TRANSPARENCY`, `SUBSCRIBE_AND_SAVE`
+     */
+    'programs'?: Array<string>;
+    'product': ItemProduct;
+    'proceeds'?: ItemProceeds;
+    'expense'?: ItemExpense;
+    'promotion'?: ItemPromotion;
+    'cancellation'?: ItemCancellation;
+    'fulfillment'?: ItemFulfillment;
+}

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

@@ -0,0 +1,49 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { MerchantAddress } from './merchant-address';
+import type { PackageItem } from './package-item';
+import type { PackageStatus } from './package-status';
+/**
+ * Information about a physical shipping package, including tracking details. **Note:** Only available for merchant-fulfilled (FBM) orders.
+ */
+export interface OrderPackage {
+    /**
+     * A unique identifier for this package within the context of the order.
+     */
+    'packageReferenceId': string;
+    /**
+     * The exact time when this shipping package was created and prepared for shipment. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+     */
+    'createdTime'?: string;
+    'packageStatus'?: PackageStatus;
+    /**
+     * The carrier responsible for transporting this package to the customer.
+     */
+    'carrier'?: string;
+    /**
+     * The exact time when this package was handed over to the carrier and began its journey to the customer. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+     */
+    'shipTime'?: string;
+    /**
+     * The specific shipping method or service used for delivering this package.
+     */
+    'shippingService'?: string;
+    /**
+     * The carrier-provided tracking number that customers can use to monitor the package\'s delivery progress.
+     */
+    'trackingNumber'?: string;
+    'shipFromAddress'?: MerchantAddress;
+    /**
+     * A list of all order items included in this specific package.
+     */
+    'packageItems'?: Array<PackageItem>;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Money } from './money';
+/**
+ * The money that the seller receives from the sale of the order.
+ */
+export interface OrderProceeds {
+    'grandTotal'?: Money;
+}

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

@@ -0,0 +1,62 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Alias } from './alias';
+import type { AssociatedOrder } from './associated-order';
+import type { Buyer } from './buyer';
+import type { OrderFulfillment } from './order-fulfillment';
+import type { OrderItem } from './order-item';
+import type { OrderPackage } from './order-package';
+import type { OrderProceeds } from './order-proceeds';
+import type { Recipient } from './recipient';
+import type { SalesChannel } from './sales-channel';
+/**
+ * Comprehensive information about a customer order.
+ */
+export interface Order {
+    /**
+     * An Amazon-defined order identifier.
+     */
+    'orderId': string;
+    /**
+     * Alternative identifiers that can be used to reference this order, such as seller-defined order numbers.
+     */
+    'orderAliases'?: Array<Alias>;
+    /**
+     * The time when the customer placed the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+     */
+    'createdTime': string;
+    /**
+     * The most recent time when any aspect of this order was modified by Amazon or the seller. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
+     */
+    'lastUpdatedTime': string;
+    /**
+     * Special programs associated with this order that may affect fulfillment or customer experience.   **Possible values**: `AMAZON_BAZAAR`, `AMAZON_BUSINESS`,  `AMAZON_EASY_SHIP`, `AMAZON_HAUL`, `DELIVERY_BY_AMAZON`, `FBM_SHIP_PLUS`, `IN_STORE_PICK_UP`, `PREMIUM`, `PREORDER`, `PRIME`
+     */
+    'programs'?: Array<string>;
+    /**
+     * Other orders that have a direct relationship to this order, such as replacement or exchange orders.
+     */
+    'associatedOrders'?: Array<AssociatedOrder>;
+    'salesChannel': SalesChannel;
+    'buyer'?: Buyer;
+    'recipient'?: Recipient;
+    'proceeds'?: OrderProceeds;
+    'fulfillment'?: OrderFulfillment;
+    /**
+     * The list of all order items included in this order.
+     */
+    'orderItems': Array<OrderItem>;
+    /**
+     * Shipping packages created for this order, including tracking information. **Note:** Only available for merchant-fulfilled (FBM) orders.
+     */
+    'packages'?: Array<OrderPackage>;
+}

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

@@ -0,0 +1,28 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Individual order item contained within a shipping package.
+ */
+export interface PackageItem {
+    /**
+     * Unique identifier of the order item included in this package.
+     */
+    'orderItemId': string;
+    /**
+     * Number of units of this item included in the package shipment.
+     */
+    'quantity': number;
+    /**
+     * The transparency codes associated with this item for product authentication.
+     */
+    'transparencyCodes'?: Array<string>;
+}

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

@@ -0,0 +1,33 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Current status and detailed tracking information for a shipping package throughout the delivery process.
+ */
+export interface PackageStatus {
+    /**
+     * Primary status classification of the package in the shipping workflow.
+     */
+    'status': PackageStatusStatusEnum;
+    /**
+     * Granular status information providing specific details about the package\'s current location and handling stage.   **Possible values:** - `PENDING_SCHEDULE` (Package awaiting pickup scheduling) - `PENDING_PICK_UP` (Package ready for carrier collection from seller) - `PENDING_DROP_OFF` (Package awaiting seller delivery to carrier) - `LABEL_CANCELLED` (Shipping label canceled by seller) - `PICKED_UP` (Package collected by carrier from seller location) - `DROPPED_OFF` (Package delivered to carrier by seller) - `AT_ORIGIN_FC` (Package at originating fulfillment center) - `AT_DESTINATION_FC` (Package at destination fulfillment center) - `DELIVERED` (Package successfully delivered to recipient) - `REJECTED_BY_BUYER` (Package refused by intended recipient) - `UNDELIVERABLE` (Package cannot be delivered due to address or access issues) - `RETURNING_TO_SELLER` (Package in transit back to seller) - `RETURNED_TO_SELLER` (Package successfully returned to seller) - `LOST` (Package location unknown or confirmed lost) - `OUT_FOR_DELIVERY` (Package on delivery vehicle for final delivery) - `DAMAGED` (Package damaged during transit)
+     */
+    'detailedStatus'?: string;
+}
+export declare const PackageStatusStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly InTransit: "IN_TRANSIT";
+    readonly Shipped: "SHIPPED";
+    readonly Delivered: "DELIVERED";
+    readonly Cancelled: "CANCELLED";
+    readonly Undeliverable: "UNDELIVERABLE";
+};
+export type PackageStatusStatusEnum = typeof PackageStatusStatusEnum[keyof typeof PackageStatusStatusEnum];

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

@@ -0,0 +1,20 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * When a request has results that are not included in the response, pagination occurs. This means the results are divided into individual pages. To retrieve a different page, you must pass the token value as the `paginationToken` query parameter in the subsequent request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `maxResultsPerPage` and `includedData`, which can be modified between calls. The token will expire after 24 hours. When there are no other pages to fetch, the `pagination` field will be absent from the response.
+ */
+export interface Pagination {
+    /**
+     * A token that can be used to fetch the next page of results.
+     */
+    'nextToken'?: string;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Money } from './money';
+/**
+ * Information about Amazon Points awarded with an item purchase.
+ */
+export interface PointsGranted {
+    /**
+     * Total number of Amazon Points granted to the customer\'s account for this item purchase.
+     */
+    'pointsNumber'?: number;
+    'pointsMonetaryValue'?: Money;
+}

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

@@ -0,0 +1,26 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { BusinessHour } from './business-hour';
+import type { ExceptionDate } from './exception-date';
+/**
+ * Customer-specified time preferences for when deliveries should be attempted at the destination address.
+ */
+export interface PreferredDeliveryTime {
+    /**
+     * Business hours when the business is open for deliveries.
+     */
+    'businessHours'?: Array<BusinessHour>;
+    /**
+     * Specific dates within the next 30 days when normal business hours do not apply.
+     */
+    'exceptionDates'?: Array<ExceptionDate>;
+}

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

@@ -0,0 +1,20 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CustomerAddress } from './customer-address';
+import type { DeliveryPreference } from './delivery-preference';
+/**
+ * Information about the recipient to whom the order should be delivered.
+ */
+export interface Recipient {
+    'deliveryAddress'?: CustomerAddress;
+    'deliveryPreference'?: DeliveryPreference;
+}

package/dist/types/api-model/models/sales-channel.d.ts

@@ -0,0 +1,28 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Information about where the customer placed this order.
+ */
+export interface SalesChannel {
+    /**
+     * The name of the sales platform or channel where the customer placed this order.  **Possible values**: `AMAZON`, `NON_AMAZON`
+     */
+    'channelName': string;
+    /**
+     * The unique identifier for the specific marketplace within the sales channel where this order was placed.
+     */
+    'marketplaceId'?: string;
+    /**
+     * The human-readable name of the marketplace where this order was placed.
+     */
+    'marketplaceName'?: string;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Order } from './order';
+import type { Pagination } from './pagination';
+/**
+ * A list of orders.
+ */
+export interface SearchOrdersResponse {
+    /**
+     * An array containing all orders that match the search criteria.
+     */
+    'orders': Array<Order>;
+    'pagination'?: Pagination;
+    /**
+     * Only orders updated before the specified time are returned. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
+     */
+    'lastUpdatedBefore'?: string;
+    /**
+     * Only orders placed before the specified time are returned. The date must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
+     */
+    'createdBefore'?: string;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * The Selling Partner API for Orders
+ * The Selling Partner API for Orders returns orders information. This API supports the following types of orders:  - FBM (Fulfilled by Merchant) - FBA (Fulfilled by Amazon) - read only - Amazon Fresh  This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { HourMinute } from './hour-minute';
+/**
+ * Specific time interval defining the start and end times.
+ */
+export interface TimeWindow {
+    'startTime'?: HourMinute;
+    'endTime'?: HourMinute;
+}

package/dist/types/client.d.ts

@@ -0,0 +1,6 @@
+import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
+import { OrdersApi } from './api-model';
+export declare const clientRateLimits: RateLimit[];
+export declare class OrdersApiClient extends OrdersApi {
+    constructor(configuration: ClientConfiguration);
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './api-model/api';
+export * from './api-model/models';

package/package.json

@@ -2,14 +2,43 @@
   "name": "@sp-api-sdk/orders-api-2026-01-01",
   "author": "Bertrand Marron <bertrand@bizon.solutions>",
   "description": "The Selling Partner API for Orders returns orders information. This API supports the following types of orders: FBM (Fulfilled by Merchant) FBA (Fulfilled by Amazon) - read only Amazon Fresh This API does not display order data that is more than two years old, except in the JP, AU, and SG marketplaces, for which data from 2016 and after is available.",
-  "version": "0.0.0",
+  "version": "1.1.1",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.js",
+  "types": "dist/types/index.d.ts",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
+  "directories": {
+    "lib": "dist"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "dependencies": {
+    "@sp-api-sdk/common": "2.1.28",
+    "axios": "^1.13.5"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/bizon/selling-partner-api-sdk.git",
     "directory": "clients/orders-api-2026-01-01"
-  }
-}
+  },
+  "bugs": {
+    "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
+  },
+  "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/orders-api-2026-01-01",
+  "keywords": [
+    "amazon",
+    "bizon",
+    "marketplace web services",
+    "mws",
+    "selling partner api",
+    "sp api",
+    "sp sdk",
+    "orders api"
+  ],
+  "gitHead": "111f635ee267c031683ba5cd53937a7f381574be"
+}