@scaleleap/selling-partner-api-sdk
Version:
📦 A fully typed TypeScript and Node.js SDK library for Amazon Selling Partner API
1,733 lines • 157 kB
TypeScript
/**
* Orders v0
* Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. _Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don\'t show up in the response).
*
* 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 { Configuration } from './configuration';
import { AxiosPromise, AxiosInstance } from 'axios';
import { RequestArgs, BaseAPI } from './base';
/**
* The shipping address for the order.
* @export
* @interface Address
*/
export interface Address {
/**
* The name.
* @type {string}
* @memberof Address
*/
Name: string;
/**
* The company name of the recipient. **Note**: This attribute is only available for shipping address.
* @type {string}
* @memberof Address
*/
CompanyName?: string;
/**
* The street address.
* @type {string}
* @memberof Address
*/
AddressLine1?: string;
/**
* Additional street address information, if required.
* @type {string}
* @memberof Address
*/
AddressLine2?: string;
/**
* Additional street address information, if required.
* @type {string}
* @memberof Address
*/
AddressLine3?: string;
/**
* The city.
* @type {string}
* @memberof Address
*/
City?: string;
/**
* The county.
* @type {string}
* @memberof Address
*/
County?: string;
/**
* The district.
* @type {string}
* @memberof Address
*/
District?: string;
/**
* The state or region.
* @type {string}
* @memberof Address
*/
StateOrRegion?: string;
/**
* The municipality.
* @type {string}
* @memberof Address
*/
Municipality?: string;
/**
* The postal code.
* @type {string}
* @memberof Address
*/
PostalCode?: string;
/**
* The country code. A two-character country code, in ISO 3166-1 alpha-2 format.
* @type {string}
* @memberof Address
*/
CountryCode?: string;
/**
* The phone number of the buyer. **Note**: 1. This attribute is only available for shipping address. 2. In some cases, the buyer phone number is suppressed: a. Phone is suppressed for all `AFN` (fulfilled by Amazon) orders. b. Phone is suppressed for the shipped `MFN` (fulfilled by seller) order when the current date is past the Latest Delivery Date.
* @type {string}
* @memberof Address
*/
Phone?: string;
/**
*
* @type {AddressExtendedFields}
* @memberof Address
*/
ExtendedFields?: AddressExtendedFields;
/**
* The address type of the shipping address.
* @type {string}
* @memberof Address
*/
AddressType?: AddressAddressTypeEnum | 'Residential' | 'Commercial';
}
/**
* @export
* @enum {string}
*/
export declare enum AddressAddressTypeEnum {
Residential = "Residential",
Commercial = "Commercial"
}
/**
* The container for address extended fields (such as `street name` and `street number`). Currently only available with Brazil shipping addresses.
* @export
* @interface AddressExtendedFields
*/
export interface AddressExtendedFields {
/**
* The street name.
* @type {string}
* @memberof AddressExtendedFields
*/
StreetName?: string;
/**
* The house, building, or property number associated with the location\'s street address.
* @type {string}
* @memberof AddressExtendedFields
*/
StreetNumber?: string;
/**
* The floor number/unit number in the building/private house number.
* @type {string}
* @memberof AddressExtendedFields
*/
Complement?: string;
/**
* The neighborhood. This value is only used in some countries (such as Brazil).
* @type {string}
* @memberof AddressExtendedFields
*/
Neighborhood?: string;
}
/**
* Contains the list of programs that are associated with an item. Possible programs are: - **Subscribe and Save**: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products.
* @export
* @interface AmazonPrograms
*/
export interface AmazonPrograms {
/**
* A list of the programs that are associated with the specified order item. **Possible values**: `SUBSCRIBE_AND_SAVE`
* @type {Array<string>}
* @memberof AmazonPrograms
*/
Programs: Array<string>;
}
/**
* An item that is associated with an order item. For example, a tire installation service that is purchased with tires.
* @export
* @interface AssociatedItem
*/
export interface AssociatedItem {
/**
* The order item\'s order identifier, in 3-7-7 format.
* @type {string}
* @memberof AssociatedItem
*/
OrderId?: string;
/**
* An Amazon-defined item identifier for the associated item.
* @type {string}
* @memberof AssociatedItem
*/
OrderItemId?: string;
/**
*
* @type {AssociationType}
* @memberof AssociatedItem
*/
AssociationType?: AssociationType | 'VALUE_ADD_SERVICE';
}
/**
* The type of association an item has with an order item.
* @export
* @enum {string}
*/
export declare enum AssociationType {
ValueAddService = "VALUE_ADD_SERVICE"
}
/**
* Contains information regarding the Shipping Settings Automation program, such as whether the order\'s shipping settings were generated automatically, and what those settings are.
* @export
* @interface AutomatedShippingSettings
*/
export interface AutomatedShippingSettings {
/**
* When true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order.
* @type {boolean}
* @memberof AutomatedShippingSettings
*/
HasAutomatedShippingSettings?: boolean;
/**
* Auto-generated carrier for SSA orders.
* @type {string}
* @memberof AutomatedShippingSettings
*/
AutomatedCarrier?: string;
/**
* Auto-generated ship method for SSA orders.
* @type {string}
* @memberof AutomatedShippingSettings
*/
AutomatedShipMethod?: string;
}
/**
* Business days and hours when the destination is open for deliveries.
* @export
* @interface BusinessHours
*/
export interface BusinessHours {
/**
* Day of the week.
* @type {string}
* @memberof BusinessHours
*/
DayOfWeek?: BusinessHoursDayOfWeekEnum | 'SUN' | 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT';
/**
* Time window during the day when the business is open.
* @type {Array<OpenInterval>}
* @memberof BusinessHours
*/
OpenIntervals?: Array<OpenInterval>;
}
/**
* @export
* @enum {string}
*/
export declare enum BusinessHoursDayOfWeekEnum {
Sun = "SUN",
Mon = "MON",
Tue = "TUE",
Wed = "WED",
Thu = "THU",
Fri = "FRI",
Sat = "SAT"
}
/**
* Buyer information for custom orders from the Amazon Custom program.
* @export
* @interface BuyerCustomizedInfoDetail
*/
export interface BuyerCustomizedInfoDetail {
/**
* The location of a ZIP file containing Amazon Custom data.
* @type {string}
* @memberof BuyerCustomizedInfoDetail
*/
CustomizedURL?: string;
}
/**
* Buyer information.
* @export
* @interface BuyerInfo
*/
export interface BuyerInfo {
/**
* The anonymized email address of the buyer.
* @type {string}
* @memberof BuyerInfo
*/
BuyerEmail?: string;
/**
* The buyer name or the recipient name.
* @type {string}
* @memberof BuyerInfo
*/
BuyerName?: string;
/**
* The county of the buyer. **Note**: This attribute is only available in the Brazil marketplace.
* @type {string}
* @memberof BuyerInfo
*/
BuyerCounty?: string;
/**
*
* @type {BuyerTaxInfo}
* @memberof BuyerInfo
*/
BuyerTaxInfo?: BuyerTaxInfo;
/**
* The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.
* @type {string}
* @memberof BuyerInfo
*/
PurchaseOrderNumber?: string;
}
/**
* Information about whether or not a buyer requested cancellation.
* @export
* @interface BuyerRequestedCancel
*/
export interface BuyerRequestedCancel {
/**
* Indicate whether the buyer has requested cancellation. **Possible Values**: `true`, `false`.
* @type {string}
* @memberof BuyerRequestedCancel
*/
IsBuyerRequestedCancel?: string;
/**
* The reason that the buyer requested cancellation.
* @type {string}
* @memberof BuyerRequestedCancel
*/
BuyerCancelReason?: string;
}
/**
* Tax information about the buyer.
* @export
* @interface BuyerTaxInfo
*/
export interface BuyerTaxInfo {
/**
* The legal name of the company.
* @type {string}
* @memberof BuyerTaxInfo
*/
CompanyLegalName?: string;
/**
* The country or region imposing the tax.
* @type {string}
* @memberof BuyerTaxInfo
*/
TaxingRegion?: string;
/**
* A list of tax classifications that apply to the order.
* @type {Array<TaxClassification>}
* @memberof BuyerTaxInfo
*/
TaxClassifications?: Array<TaxClassification>;
}
/**
* Contains the business invoice tax information. Available only in the TR marketplace.
* @export
* @interface BuyerTaxInformation
*/
export interface BuyerTaxInformation {
/**
* Business buyer\'s company legal name.
* @type {string}
* @memberof BuyerTaxInformation
*/
BuyerLegalCompanyName?: string;
/**
* Business buyer\'s address.
* @type {string}
* @memberof BuyerTaxInformation
*/
BuyerBusinessAddress?: string;
/**
* Business buyer\'s tax registration ID.
* @type {string}
* @memberof BuyerTaxInformation
*/
BuyerTaxRegistrationId?: string;
/**
* Business buyer\'s tax office.
* @type {string}
* @memberof BuyerTaxInformation
*/
BuyerTaxOffice?: string;
}
/**
* The error response schema for the `confirmShipment` operation.
* @export
* @interface ConfirmShipmentErrorResponse
*/
export interface ConfirmShipmentErrorResponse {
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array<Error>}
* @memberof ConfirmShipmentErrorResponse
*/
errors?: Array<Error>;
}
/**
* A single order item.
* @export
* @interface ConfirmShipmentOrderItem
*/
export interface ConfirmShipmentOrderItem {
/**
* The order item\'s unique identifier.
* @type {string}
* @memberof ConfirmShipmentOrderItem
*/
orderItemId: string;
/**
* The item\'s quantity.
* @type {number}
* @memberof ConfirmShipmentOrderItem
*/
quantity: number;
/**
* A list of order items.
* @type {Array<string>}
* @memberof ConfirmShipmentOrderItem
*/
transparencyCodes?: Array<string>;
}
/**
* The request schema for an shipment confirmation.
* @export
* @interface ConfirmShipmentRequest
*/
export interface ConfirmShipmentRequest {
/**
*
* @type {PackageDetail}
* @memberof ConfirmShipmentRequest
*/
packageDetail: PackageDetail;
/**
* The COD collection method (only supported in the JP marketplace).
* @type {string}
* @memberof ConfirmShipmentRequest
*/
codCollectionMethod?: ConfirmShipmentRequestCodCollectionMethodEnum | 'DirectPayment';
/**
* The unobfuscated marketplace identifier.
* @type {string}
* @memberof ConfirmShipmentRequest
*/
marketplaceId: string;
}
/**
* @export
* @enum {string}
*/
export declare enum ConfirmShipmentRequestCodCollectionMethodEnum {
DirectPayment = "DirectPayment"
}
/**
* Details the importance of the constraint present on the item
* @export
* @enum {string}
*/
export declare enum ConstraintType {
Mandatory = "MANDATORY"
}
/**
* Contains all of the delivery instructions provided by the customer for the shipping address.
* @export
* @interface DeliveryPreferences
*/
export interface DeliveryPreferences {
/**
* Drop-off location selected by the customer.
* @type {string}
* @memberof DeliveryPreferences
*/
DropOffLocation?: string;
/**
*
* @type {PreferredDeliveryTime}
* @memberof DeliveryPreferences
*/
PreferredDeliveryTime?: PreferredDeliveryTime;
/**
* Enumerated list of miscellaneous delivery attributes associated with the shipping address.
* @type {Array<OtherDeliveryAttributes>}
* @memberof DeliveryPreferences
*/
OtherAttributes?: Array<(OtherDeliveryAttributes | 'HAS_ACCESS_POINT' | 'PALLET_ENABLED' | 'PALLET_DISABLED')>;
/**
* Building instructions, nearby landmark or navigation instructions.
* @type {string}
* @memberof DeliveryPreferences
*/
AddressInstructions?: string;
}
/**
* The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.
* @export
* @enum {string}
*/
export declare enum EasyShipShipmentStatus {
PendingSchedule = "PendingSchedule",
PendingPickUp = "PendingPickUp",
PendingDropOff = "PendingDropOff",
LabelCanceled = "LabelCanceled",
PickedUp = "PickedUp",
DroppedOff = "DroppedOff",
AtOriginFc = "AtOriginFC",
AtDestinationFc = "AtDestinationFC",
Delivered = "Delivered",
RejectedByBuyer = "RejectedByBuyer",
Undeliverable = "Undeliverable",
ReturningToSeller = "ReturningToSeller",
ReturnedToSeller = "ReturnedToSeller",
Lost = "Lost",
OutForDelivery = "OutForDelivery",
Damaged = "Damaged"
}
/**
* The status of the electronic invoice. Only available for Easy Ship orders and orders in the BR marketplace.
* @export
* @enum {string}
*/
export declare enum ElectronicInvoiceStatus {
NotRequired = "NotRequired",
NotFound = "NotFound",
Processing = "Processing",
Errored = "Errored",
Accepted = "Accepted"
}
/**
* Dates when the business is closed or open with a different time window.
* @export
* @interface ExceptionDates
*/
export interface ExceptionDates {
/**
* Date when the business is closed, in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date format.
* @type {string}
* @memberof ExceptionDates
*/
ExceptionDate?: string;
/**
* Boolean indicating if the business is closed or open on that date.
* @type {boolean}
* @memberof ExceptionDates
*/
IsOpen?: boolean;
/**
* Time window during the day when the business is open.
* @type {Array<OpenInterval>}
* @memberof ExceptionDates
*/
OpenIntervals?: Array<OpenInterval>;
}
/**
* Contains the instructions about the fulfillment, such as the location from where you want the order filled.
* @export
* @interface FulfillmentInstruction
*/
export interface FulfillmentInstruction {
/**
* The `sourceId` of the location from where you want the order fulfilled.
* @type {string}
* @memberof FulfillmentInstruction
*/
FulfillmentSupplySourceId?: string;
}
/**
* The response schema for the `getOrderAddress` operation.
* @export
* @interface GetOrderAddressResponse
*/
export interface GetOrderAddressResponse {
/**
*
* @type {OrderAddress}
* @memberof GetOrderAddressResponse
*/
payload?: OrderAddress;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array<Error>}
* @memberof GetOrderAddressResponse
*/
errors?: Array<Error>;
}
/**
* The response schema for the `getOrderBuyerInfo` operation.
* @export
* @interface GetOrderBuyerInfoResponse
*/
export interface GetOrderBuyerInfoResponse {
/**
*
* @type {OrderBuyerInfo}
* @memberof GetOrderBuyerInfoResponse
*/
payload?: OrderBuyerInfo;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array<Error>}
* @memberof GetOrderBuyerInfoResponse
*/
errors?: Array<Error>;
}
/**
* The response schema for the `getOrderItemsBuyerInfo` operation.
* @export
* @interface GetOrderItemsBuyerInfoResponse
*/
export interface GetOrderItemsBuyerInfoResponse {
/**
*
* @type {OrderItemsBuyerInfoList}
* @memberof GetOrderItemsBuyerInfoResponse
*/
payload?: OrderItemsBuyerInfoList;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array<Error>}
* @memberof GetOrderItemsBuyerInfoResponse
*/
errors?: Array<Error>;
}
/**
* The response schema for the `getOrderItems` operation.
* @export
* @interface GetOrderItemsResponse
*/
export interface GetOrderItemsResponse {
/**
*
* @type {OrderItemsList}
* @memberof GetOrderItemsResponse
*/
payload?: OrderItemsList;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array<Error>}
* @memberof GetOrderItemsResponse
*/
errors?: Array<Error>;
}
/**
* The response schema for the `getOrderRegulatedInfo` operation.
* @export
* @interface GetOrderRegulatedInfoResponse
*/
export interface GetOrderRegulatedInfoResponse {
/**
*
* @type {OrderRegulatedInfo}
* @memberof GetOrderRegulatedInfoResponse
*/
payload?: OrderRegulatedInfo;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array<Error>}
* @memberof GetOrderRegulatedInfoResponse
*/
errors?: Array<Error>;
}
/**
* The response schema for the `getOrder` operation.
* @export
* @interface GetOrderResponse
*/
export interface GetOrderResponse {
/**
*
* @type {Order}
* @memberof GetOrderResponse
*/
payload?: Order;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array<Error>}
* @memberof GetOrderResponse
*/
errors?: Array<Error>;
}
/**
* The response schema for the `getOrders` operation.
* @export
* @interface GetOrdersResponse
*/
export interface GetOrdersResponse {
/**
*
* @type {OrdersList}
* @memberof GetOrdersResponse
*/
payload?: OrdersList;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array<Error>}
* @memberof GetOrdersResponse
*/
errors?: Array<Error>;
}
/**
* A single item\'s buyer information.
* @export
* @interface ItemBuyerInfo
*/
export interface ItemBuyerInfo {
/**
*
* @type {BuyerCustomizedInfoDetail}
* @memberof ItemBuyerInfo
*/
BuyerCustomizedInfo?: BuyerCustomizedInfoDetail;
/**
*
* @type {Money}
* @memberof ItemBuyerInfo
*/
GiftWrapPrice?: Money;
/**
*
* @type {Money}
* @memberof ItemBuyerInfo
*/
GiftWrapTax?: Money;
/**
* A gift message provided by the buyer. **Note**: This attribute is only available for MFN (fulfilled by seller) orders.
* @type {string}
* @memberof ItemBuyerInfo
*/
GiftMessageText?: string;
/**
* The gift wrap level specified by the buyer.
* @type {string}
* @memberof ItemBuyerInfo
*/
GiftWrapLevel?: string;
}
/**
* Tax information about the marketplace.
* @export
* @interface MarketplaceTaxInfo
*/
export interface MarketplaceTaxInfo {
/**
* A list of tax classifications that apply to the order.
* @type {Array<TaxClassification>}
* @memberof MarketplaceTaxInfo
*/
TaxClassifications?: Array<TaxClassification>;
}
/**
* Measurement information for an order item.
* @export
* @interface Measurement
*/
export interface Measurement {
/**
* The unit of measure.
* @type {string}
* @memberof Measurement
*/
Unit: MeasurementUnitEnum | 'OUNCES' | 'POUNDS' | 'KILOGRAMS' | 'GRAMS' | 'MILLIGRAMS' | 'INCHES' | 'FEET' | 'METERS' | 'CENTIMETERS' | 'MILLIMETERS' | 'SQUARE_METERS' | 'SQUARE_CENTIMETERS' | 'SQUARE_FEET' | 'SQUARE_INCHES' | 'GALLONS' | 'PINTS' | 'QUARTS' | 'FLUID_OUNCES' | 'LITERS' | 'CUBIC_METERS' | 'CUBIC_FEET' | 'CUBIC_INCHES' | 'CUBIC_CENTIMETERS' | 'COUNT';
/**
* The measurement value.
* @type {number}
* @memberof Measurement
*/
Value: number;
}
/**
* @export
* @enum {string}
*/
export declare enum MeasurementUnitEnum {
Ounces = "OUNCES",
Pounds = "POUNDS",
Kilograms = "KILOGRAMS",
Grams = "GRAMS",
Milligrams = "MILLIGRAMS",
Inches = "INCHES",
Feet = "FEET",
Meters = "METERS",
Centimeters = "CENTIMETERS",
Millimeters = "MILLIMETERS",
SquareMeters = "SQUARE_METERS",
SquareCentimeters = "SQUARE_CENTIMETERS",
SquareFeet = "SQUARE_FEET",
SquareInches = "SQUARE_INCHES",
Gallons = "GALLONS",
Pints = "PINTS",
Quarts = "QUARTS",
FluidOunces = "FLUID_OUNCES",
Liters = "LITERS",
CubicMeters = "CUBIC_METERS",
CubicFeet = "CUBIC_FEET",
CubicInches = "CUBIC_INCHES",
CubicCentimeters = "CUBIC_CENTIMETERS",
Count = "COUNT"
}
/**
* Error response returned when the request is unsuccessful.
* @export
* @interface ModelError
*/
export interface ModelError {
/**
* An error code that identifies the type of error that occurred.
* @type {string}
* @memberof ModelError
*/
code: string;
/**
* A message that describes the error condition.
* @type {string}
* @memberof ModelError
*/
message: string;
/**
* Additional details that can help the caller understand or fix the issue.
* @type {string}
* @memberof ModelError
*/
details?: string;
}
/**
* The monetary value of the order.
* @export
* @interface Money
*/
export interface Money {
/**
* The three-digit currency code. In ISO 4217 format.
* @type {string}
* @memberof Money
*/
CurrencyCode?: string;
/**
* The currency amount.
* @type {string}
* @memberof Money
*/
Amount?: string;
}
/**
* The time interval for which the business is open.
* @export
* @interface OpenInterval
*/
export interface OpenInterval {
/**
*
* @type {OpenTimeInterval}
* @memberof OpenInterval
*/
StartTime?: OpenTimeInterval;
/**
*
* @type {OpenTimeInterval}
* @memberof OpenInterval
*/
EndTime?: OpenTimeInterval;
}
/**
* The time when the business opens or closes.
* @export
* @interface OpenTimeInterval
*/
export interface OpenTimeInterval {
/**
* The hour when the business opens or closes.
* @type {number}
* @memberof OpenTimeInterval
*/
Hour?: number;
/**
* The minute when the business opens or closes.
* @type {number}
* @memberof OpenTimeInterval
*/
Minute?: number;
}
/**
* 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 | 'Pending' | 'Unshipped' | 'PartiallyShipped' | 'Shipped' | 'Canceled' | 'Unfulfillable' | 'InvoiceUnconfirmed' | 'PendingAvailability';
/**
* Whether the order was fulfilled by Amazon (`AFN`) or by the seller (`MFN`).
* @type {string}
* @memberof Order
*/
FulfillmentChannel?: OrderFulfillmentChannelEnum | 'MFN' | 'AFN';
/**
* The sales channel for the first item in the order.
* @type {string}
* @memberof Order
*/
SalesChannel?: string;
/**
* The order channel for the first item in the order.
* @type {string}
* @memberof Order
*/
OrderChannel?: string;
/**
* The order\'s shipment service level.
* @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 COD and 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 | 'COD' | 'CVS' | 'Other';
/**
* 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 for the order. **Possible values**: `Expedited`, `FreeEconomy`, `NextDay`, `Priority`, `SameDay`, `SecondDay`, `Scheduled`, and `Standard`.
* @type {string}
* @memberof Order
*/
ShipmentServiceLevelCategory?: string;
/**
*
* @type {EasyShipShipmentStatus}
* @memberof Order
*/
EasyShipShipmentStatus?: EasyShipShipmentStatus | 'PendingSchedule' | 'PendingPickUp' | 'PendingDropOff' | 'LabelCanceled' | 'PickedUp' | 'DroppedOff' | 'AtOriginFC' | 'AtDestinationFC' | 'Delivered' | 'RejectedByBuyer' | 'Undeliverable' | 'ReturningToSeller' | 'ReturnedToSeller' | 'Lost' | 'OutForDelivery' | 'Damaged';
/**
* Custom ship label for Checkout by Amazon (CBA).
* @type {string}
* @memberof Order
*/
CbaDisplayableShippingLabel?: string;
/**
* The order\'s type.
* @type {string}
* @memberof Order
*/
OrderType?: OrderOrderTypeEnum | 'StandardOrder' | 'LongLeadTimeOrder' | 'Preorder' | 'BackOrder' | 'SourcingOnDemandOrder';
/**
* The start of the time period within which you have committed to ship the order. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned 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](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned 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](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned 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](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. Only returned 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, refer to \"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. Only returned for Sourcing on Demand orders.
* @type {string}
* @memberof Order
*/
PromiseResponseDueDate?: string;
/**
* When true, the estimated ship date is set for the order. Only returned 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;
/**
* 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;
/**
*
* @type {Address}
* @memberof Order
*/
DefaultShipFromLocationAddress?: Address;
/**
* The buyer\'s invoicing preference. Sellers can use this data to issue electronic invoices for orders in Turkey. **Note**: This attribute is only available in the Turkey marketplace.
* @type {string}
* @memberof Order
*/
BuyerInvoicePreference?: OrderBuyerInvoicePreferenceEnum | 'INDIVIDUAL' | 'BUSINESS';
/**
*
* @type {BuyerTaxInformation}
* @memberof Order
*/
BuyerTaxInformation?: BuyerTaxInformation;
/**
*
* @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;
/**
* 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;
/**
* The seller’s friendly name registered in the marketplace where the sale took place. Sellers can use this data to issue electronic invoices for orders in Brazil. **Note**: This attribute is only available in the Brazil marketplace for the orders with `Pending` or `Unshipped` status.
* @type {string}
* @memberof Order
*/
SellerDisplayName?: string;
/**
*
* @type {Address}
* @memberof Order
*/
ShippingAddress?: Address;
/**
*
* @type {BuyerInfo}
* @memberof Order
*/
BuyerInfo?: BuyerInfo;
/**
*
* @type {AutomatedShippingSettings}
* @memberof Order
*/
AutomatedShippingSettings?: AutomatedShippingSettings;
/**
* Whether the order contains regulated items which may require additional approval steps before being fulfilled.
* @type {boolean}
* @memberof Order
*/
HasRegulatedItems?: boolean;
/**
*
* @type {ElectronicInvoiceStatus}
* @memberof Order
*/
ElectronicInvoiceStatus?: ElectronicInvoiceStatus | 'NotRequired' | 'NotFound' | 'Processing' | 'Errored' | 'Accepted';
}
/**
* @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"
}
/**
* The shipping address for the order.
* @export
* @interface OrderAddress
*/
export interface OrderAddress {
/**
* An Amazon-defined order identifier, in 3-7-7 format.
* @type {string}
* @memberof OrderAddress
*/
AmazonOrderId: string;
/**
* The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities.
* @type {string}
* @memberof OrderAddress
*/
BuyerCompanyName?: string;
/**
*
* @type {Address}
* @memberof OrderAddress
*/
ShippingAddress?: Address;
/**
*
* @type {DeliveryPreferences}
* @memberof OrderAddress
*/
DeliveryPreferences?: DeliveryPreferences;
}
/**
* Buyer information for an order.
* @export
* @interface OrderBuyerInfo
*/
export interface OrderBuyerInfo {
/**
* An Amazon-defined order identifier, in 3-7-7 format.
* @type {string}
* @memberof OrderBuyerInfo
*/
AmazonOrderId: string;
/**
* The anonymized email address of the buyer.
* @type {string}
* @memberof OrderBuyerInfo
*/
BuyerEmail?: string;
/**
* The buyer name or the recipient name.
* @type {string}
* @memberof OrderBuyerInfo
*/
BuyerName?: string;
/**
* The county of the buyer. **Note**: This attribute is only available in the Brazil marketplace.
* @type {string}
* @memberof OrderBuyerInfo
*/
BuyerCounty?: string;
/**
*
* @type {BuyerTaxInfo}
* @memberof OrderBuyerInfo
*/
BuyerTaxInfo?: BuyerTaxInfo;
/**
* The purchase order (PO) number entered by the buyer at checkout. Only returned for orders where the buyer entered a PO number at checkout.
* @type {string}
* @memberof OrderBuyerInfo
*/
PurchaseOrderNumber?: string;
}
/**
* A single order item.
* @export
* @interface OrderItem
*/
export interface OrderItem {
/**
* The item\'s Amazon Standard Identification Number (ASIN).
* @type {string}
* @memberof OrderItem
*/
ASIN: string;
/**
* The item\'s seller stock keeping unit (SKU).
* @type {string}
* @memberof OrderItem
*/
SellerSKU?: string;
/**
* An Amazon-defined order item identifier.
* @type {string}
* @memberof OrderItem
*/
OrderItemId: string;
/**
* A list of associated items that a customer has purchased with a product. For example, a tire installation service purchased with tires.
* @type {Array<AssociatedItem>}
* @memberof OrderItem
*/
AssociatedItems?: Array<AssociatedItem>;
/**
* The item\'s name.
* @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;
/**
* Indicates whether the item is a gift. **Possible values**: `true` and `false`.
* @type {string}
* @memberof OrderItem
*/
IsGift?: string;
/**
* 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`, and `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`, and `Other`.
* @type {string}
* @memberof OrderItem
*/
ConditionSubtypeId?: string;
/**
* The start date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
* @type {string}
* @memberof OrderItem
*/
ScheduledDeliveryStartDate?: string;
/**
* The end date of the scheduled delivery window in the time zone for the order destination. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
* @type {string}
* @memberof OrderItem
*/
ScheduledDeliveryEndDate?: string;
/**
* Indicates that the selling price is a special price that is only available for Amazon Business orders. For more information about the Amazon Business Seller Program, refer to the [Amazon Business website](https://www.amazon.com/b2b/info/amazon-business). **Possible values**: `BusinessPrice`
* @type {string}
* @memberof OrderItem
*/
PriceDesignation?: string;
/**
*
* @type {TaxCollection}
* @memberof OrderItem
*/
TaxCollection?: TaxCollection;
/**
* When true, the product type for this item has a serial number. Only returned for Amazon Easy Ship orders.
* @type {boolean}
* @memberof OrderItem
*/
SerialNumberRequired?: boolean;
/**
* When true, the ASIN is enrolled in Transparency. The Transparency serial number that you must submit is determined by: **1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN). **2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode. **QR code SN:** Submit the URL that the QR code generates.
* @type {boolean}
* @memberof OrderItem
*/
IsTransparency?: boolean;
/**
* The IOSS number of the marketplace. Sellers shipping to the EU from outside 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 | 'IOSS' | 'UOSS';
/**
*
* @type {ItemBuyerInfo}
* @memberof OrderItem
*/
BuyerInfo?: ItemBuyerInfo;
/**
*
* @type {BuyerRequestedCancel}
* @memberof OrderItem
*/
BuyerRequestedCancel?: BuyerRequestedCancel;
/**
* A list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only.
* @type {Array<string>}
* @memberof OrderItem
*/
SerialNumbers?: Array<string>;
/**
*
* @type {SubstitutionPreferences}
* @memberof OrderItem
*/
SubstitutionPreferences?: SubstitutionPreferences;
/**
*
* @type {Measurement}
* @memberof OrderItem
*/
Measurement?: Measurement;
/**
*
* @type {ShippingConstraints}
* @memberof OrderItem
*/
ShippingConstraints?: ShippingConstraints;
/**
*
* @type {AmazonPrograms}
* @memberof OrderItem
*/
AmazonPrograms?: AmazonPrograms;
}
/**
* @export
* @enum {string}
*/
export declare enum OrderItemDeemedResellerCategoryEnum {
Ioss = "IOSS",
Uoss = "UOSS"
}
/**
* 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. **Note**: This attribute is only available for MFN (fulfilled by seller) orders.
* @type {string}
* @memberof OrderItemBuyerInfo
*/
GiftMessageText?: string;
/**
* The gift wrap level specified by the buyer.
* @type {string}
* @memberof OrderItemBuyerInfo
*/
GiftWrapLevel?: string;
}
/**
* 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;
}
/**
* 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;
}
/**
* The order\'s regulated information along with its verification status.
* @export
* @interface OrderRegulatedInfo
*/
export interface OrderRegulatedInfo {
/**
* An Amazon-defined order identifier, in 3-7-7 format.
* @type {string}
* @memberof OrderRegulatedInfo
*/
AmazonOrderId: string;
/**
*
* @type {RegulatedInformation}
* @memberof OrderRegulatedInfo
*/
RegulatedInformation: RegulatedInformation;
/**
* When true, the order requires attaching a dosage information label when shipped.
* @type {boolean}
* @memberof OrderRegulatedInfo
*/
RequiresDosageLabel: boolean;
/**
*
* @type {RegulatedOrderVerificationStatus}
* @memberof OrderRegulatedInfo
*/
RegulatedOrderVerificationStatus: RegulatedOrderVerificationStatus;
}
/**
* 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
*/
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;
}
/**
* Miscellaneous delivery attributes associated with the shipping address.
* @export
* @enum {string}
*/
export declare enum OtherDeliveryAttributes {
HasAccessPoint = "HAS_ACCESS_POINT",
PalletEnabled = "PALLET_ENABLED",
PalletDisabled = "PALLET_DISABLED"
}
/**
* 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
*/
carrierName?: string;
/**
* Ship method to be used for shipping the orde