Selling Partner API SDK for JavaScript
    Preparing search index...

    Module @sp-api-sdk/orders-api-2026-01-01 - v1.0.0

    orders-api-2026-01-01

    npm version XO code style

    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.

    Bizon

    Learn more about this Selling Partner API by visiting the official documentation.

    Also, see the generated documentation for this API client.

    npm install @sp-api-sdk/orders-api-2026-01-01
    
    import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
    import {OrdersApiClient} from '@sp-api-sdk/orders-api-2026-01-01'

    const auth = new SellingPartnerApiAuth({
    clientId: process.env.LWA_CLIENT_ID,
    clientSecret: process.env.LWA_CLIENT_SECRET,
    refreshToken: 'Atzr|…',
    })

    const client = new OrdersApiClient({
    auth,
    region: 'eu',
    })

    In order to retry rate limited requests (HTTP 429), you can configure the API client as such:

    const client = new OrdersApiClient({
    auth,
    region: 'eu',
    rateLimiting: {
    retry: true,
    // Optionally specify a callback that will be called on every retry.
    onRetry: (retryInfo) => {
    console.log(retryInfo)
    },
    },
    })

    The rate limits used for each route are specified in the API documentation.

    You can enable logging for both SP-API requests and responses by configuring the logging.request and logging.response properties.

    const client = new OrdersApiClient({
    auth,
    region: 'eu',
    logging: {
    request: {
    logger: console.debug
    },
    response: {
    logger: console.debug
    },
    error: true,
    },
    })

    Specifying true will use the default options, specifying an object will allow you to override the default options.
    This uses axios-logger under the hood.
    By default, if enabled, the request and response loggers will use console.info and the error logger will use console.error.

    MIT

        ╚⊙ ⊙╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝
    ╚═(███)═╝

    Classes

    OrdersApi
    OrdersApiClient

    Interfaces

    AddressExtendedFields
    Alias
    AssociatedOrder
    BusinessHour
    Buyer
    CustomerAddress
    DateTimeRange
    DeliveryPreference
    ErrorList
    ExceptionDate
    GetOrderResponse
    GiftOption
    HourMinute
    ItemCancellation
    ItemCancellationRequest
    ItemCondition
    ItemCustomization
    ItemExpense
    ItemFulfillment
    ItemInternationalShipping
    ItemPacking
    ItemPicking
    ItemPointsCost
    ItemPrice
    ItemProceeds
    ItemProceedsBreakdown
    ItemProceedsDetailedBreakdown
    ItemProduct
    ItemPromotion
    ItemPromotionBreakdown
    ItemShipping
    ItemShippingConstraints
    ItemSubstitutionOption
    ItemSubstitutionPreference
    Measurement
    MerchantAddress
    ModelError
    Money
    Order
    OrderFulfillment
    OrderItem
    OrderPackage
    OrderProceeds
    OrdersApiGetOrderRequest
    OrdersApiSearchOrdersRequest
    PackageItem
    PackageStatus
    Pagination
    PointsGranted
    PreferredDeliveryTime
    Recipient
    SalesChannel
    SearchOrdersResponse
    TimeWindow

    Type Aliases

    BusinessHourDayOfWeekEnum
    ConstraintType
    ExceptionDateExceptionDateTypeEnum
    FulfillmentStatus
    GetOrderIncludedDataEnum
    ItemSubstitutionPreferenceSubstitutionTypeEnum
    MeasurementUnitEnum
    PackageStatusStatusEnum
    SearchOrdersFulfilledByEnum
    SearchOrdersFulfillmentStatusesEnum
    SearchOrdersIncludedDataEnum

    Variables

    BusinessHourDayOfWeekEnum
    clientRateLimits
    ConstraintType
    ExceptionDateExceptionDateTypeEnum
    FulfillmentStatus
    GetOrderIncludedDataEnum
    ItemSubstitutionPreferenceSubstitutionTypeEnum
    MeasurementUnitEnum
    PackageStatusStatusEnum
    SearchOrdersFulfilledByEnum
    SearchOrdersFulfillmentStatusesEnum
    SearchOrdersIncludedDataEnum

    Functions

    OrdersApiAxiosParamCreator
    OrdersApiFactory
    OrdersApiFp