@sp-api-sdk/orders-api-v0/dist/index.d.ts

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 too

import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
//#region src/api-model/configuration.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
interface AWSv4Configuration {
  options?: {
    region?: string;
    service?: string;
  };
  credentials?: {
    accessKeyId?: string;
    secretAccessKey?: string;
    sessionToken?: string;
  };
}
interface ConfigurationParameters {
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
  username?: string;
  password?: string;
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
  awsv4?: AWSv4Configuration;
  basePath?: string;
  serverIndex?: number;
  baseOptions?: any;
  formDataCtor?: new () => any;
}
declare class Configuration {
  /**
   * parameter for apiKey security
   * @param name security name
   */
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
  /**
   * parameter for basic security
   */
  username?: string;
  /**
   * parameter for basic security
   */
  password?: string;
  /**
   * parameter for oauth2 security
   * @param name security name
   * @param scopes oauth2 scope
   */
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
  /**
   * parameter for aws4 signature security
   * @param {Object} AWS4Signature - AWS4 Signature security
   * @param {string} options.region - aws region
   * @param {string} options.service - name of the service.
   * @param {string} credentials.accessKeyId - aws access key id
   * @param {string} credentials.secretAccessKey - aws access key
   * @param {string} credentials.sessionToken - aws session token
   * @memberof Configuration
   */
  awsv4?: AWSv4Configuration;
  /**
   * override base path
   */
  basePath?: string;
  /**
   * override server index
   */
  serverIndex?: number;
  /**
   * base options for axios calls
   */
  baseOptions?: any;
  /**
   * The FormData constructor that will be used to create multipart form data
   * requests. You can inject this here so that execution environments that
   * do not support the FormData class can still run the generated client.
   *
   * @type {new () => FormData}
   */
  formDataCtor?: new () => any;
  constructor(param?: ConfigurationParameters);
  /**
   * Check if the given MIME is a JSON MIME.
   * JSON MIME examples:
   *   application/json
   *   application/json; charset=UTF8
   *   APPLICATION/JSON
   *   application/vnd.company+json
   * @param mime - MIME (Multipurpose Internet Mail Extensions)
   * @return True if the given MIME is JSON, false otherwise.
   */
  isJsonMime(mime: string): boolean;
}
//#endregion
//#region src/api-model/base.d.ts
interface RequestArgs {
  url: string;
  options: RawAxiosRequestConfig;
}
declare class BaseAPI {
  protected basePath: string;
  protected axios: AxiosInstance;
  protected configuration: Configuration | undefined;
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
}
//#endregion
//#region src/api-model/models/geo-coordinates.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * The latitude and longitude coordinates of the shipping address using the WGS84 coordinate system.
 */
interface GeoCoordinates {
  /**
   * The latitude coordinate of the shipping address using the WGS84 coordinate system.
   */
  'Latitude'?: number;
  /**
   * The longitude coordinate of the shipping address using the WGS84 coordinate system.
   */
  'Longitude'?: number;
}
//#endregion
//#region src/api-model/models/address-extended-fields.d.ts
/**
 * Extended address fields for additional address components including the street name or number.   Note: Available for grocery sellers and Brazil shipping addresses.
 */
interface AddressExtendedFields {
  /**
   * The street name.
   */
  'StreetName'?: string;
  /**
   * The house, building, or property number associated with the location\'s street address.
   */
  'StreetNumber'?: string;
  /**
   * The floor number/unit number in the building/private house number.
   */
  'Complement'?: string;
  /**
   * The neighborhood. This value is only used in some countries (such as Brazil).
   */
  'Neighborhood'?: string;
  'GeoCoordinates'?: GeoCoordinates;
}
//#endregion
//#region src/api-model/models/address.d.ts
/**
 * The shipping address for the order.
 */
interface Address {
  /**
   * The name.
   */
  'Name'?: string;
  /**
   * The company name of the recipient.  **Note**: This attribute is only available for shipping address.
   */
  'CompanyName'?: string;
  /**
   * The street address.
   */
  'AddressLine1'?: string;
  /**
   * Additional street address information, if required.
   */
  'AddressLine2'?: string;
  /**
   * Additional street address information, if required.
   */
  'AddressLine3'?: string;
  /**
   * The city.
   */
  'City'?: string;
  /**
   * The county.
   */
  'County'?: string;
  /**
   * The district.
   */
  'District'?: string;
  /**
   * The state or region.
   */
  'StateOrRegion'?: string;
  /**
   * The municipality.
   */
  'Municipality'?: string;
  /**
   * The postal code.
   */
  'PostalCode'?: string;
  /**
   * The country code. A two-character country code, in ISO 3166-1 alpha-2 format.
   */
  '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.
   */
  'Phone'?: string;
  'ExtendedFields'?: AddressExtendedFields;
  /**
   * The address type of the shipping address.
   */
  'AddressType'?: AddressAddressTypeEnum;
}
declare const AddressAddressTypeEnum: {
  readonly Residential: "Residential";
  readonly Commercial: "Commercial";
};
type AddressAddressTypeEnum = typeof AddressAddressTypeEnum[keyof typeof AddressAddressTypeEnum];
//#endregion
//#region src/api-model/models/amazon-programs.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Contains the list of programs that Amazon associates 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. - **FBM Ship+**: Unlocks expedited shipping without the extra cost. Helps you to provide accurate and fast delivery dates to Amazon customers. You also receive protection from late deliveries, a discount on expedited shipping rates, and cash back when you ship.
 */
interface AmazonPrograms {
  /**
   * A list of the programs that Amazon associates with the order item.  **Possible values**: `SUBSCRIBE_AND_SAVE`, `FBM_SHIP_PLUS`
   */
  'Programs': Array<string>;
}
//#endregion
//#region src/api-model/models/approved-attribute.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * An order attribute with its original value and the pre-approved alternative value suggested by the vet.
 */
interface ApprovedAttribute {
  /**
   * The name of the attribute requiring correction (for example, `asin`, `petWeight`).
   */
  'attributeName': string;
  /**
   * The original value of the attribute in the rejected order.
   */
  'originalValue': string;
  /**
   * The pre-approved value that would result in order approval.
   */
  'approvedValue': string;
}
//#endregion
//#region src/api-model/models/association-type.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * The type of association an item has with an order item.
 */
declare const AssociationType: {
  readonly ValueAddService: "VALUE_ADD_SERVICE";
};
type AssociationType = typeof AssociationType[keyof typeof AssociationType];
//#endregion
//#region src/api-model/models/associated-item.d.ts
/**
 * An item that is associated with an order item. For example, a tire installation service that is purchased with tires.
 */
interface AssociatedItem {
  /**
   * The order item\'s order identifier, in 3-7-7 format.
   */
  'OrderId'?: string;
  /**
   * An Amazon-defined item identifier for the associated item.
   */
  'OrderItemId'?: string;
  'AssociationType'?: AssociationType;
}
//#endregion
//#region src/api-model/models/automated-shipping-settings.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Contains information regarding the Shipping Settings Automation program, such as whether the order\'s shipping settings were generated automatically, and what those settings are.
 */
interface AutomatedShippingSettings {
  /**
   * When true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order.
   */
  'HasAutomatedShippingSettings'?: boolean;
  /**
   * Auto-generated carrier for SSA orders.
   */
  'AutomatedCarrier'?: string;
  /**
   * Auto-generated ship method for SSA orders.
   */
  'AutomatedShipMethod'?: string;
}
//#endregion
//#region src/api-model/models/open-time-interval.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * The time when the business opens or closes.
 */
interface OpenTimeInterval {
  /**
   * The hour when the business opens or closes.
   */
  'Hour'?: number;
  /**
   * The minute when the business opens or closes.
   */
  'Minute'?: number;
}
//#endregion
//#region src/api-model/models/open-interval.d.ts
/**
 * The time interval for which the business is open.
 */
interface OpenInterval {
  'StartTime'?: OpenTimeInterval;
  'EndTime'?: OpenTimeInterval;
}
//#endregion
//#region src/api-model/models/business-hours.d.ts
/**
 * Business days and hours when the destination is open for deliveries.
 */
interface BusinessHours {
  /**
   * Day of the week.
   */
  'DayOfWeek'?: BusinessHoursDayOfWeekEnum;
  /**
   * Time window during the day when the business is open.
   */
  'OpenIntervals'?: Array<OpenInterval>;
}
declare const BusinessHoursDayOfWeekEnum: {
  readonly Sun: "SUN";
  readonly Mon: "MON";
  readonly Tue: "TUE";
  readonly Wed: "WED";
  readonly Thu: "THU";
  readonly Fri: "FRI";
  readonly Sat: "SAT";
};
type BusinessHoursDayOfWeekEnum = typeof BusinessHoursDayOfWeekEnum[keyof typeof BusinessHoursDayOfWeekEnum];
//#endregion
//#region src/api-model/models/buyer-customized-info-detail.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Buyer information for custom orders from the Amazon Custom program.
 */
interface BuyerCustomizedInfoDetail {
  /**
   * The location of a ZIP file containing Amazon Custom data.
   */
  'CustomizedURL'?: string;
}
//#endregion
//#region src/api-model/models/tax-classification.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * The tax classification of the order.
 */
interface TaxClassification {
  /**
   * The type of tax.
   */
  'Name'?: string;
  /**
   * The buyer\'s tax identifier.
   */
  'Value'?: string;
}
//#endregion
//#region src/api-model/models/buyer-tax-info.d.ts
/**
 * Tax information about the buyer.
 */
interface BuyerTaxInfo {
  /**
   * The legal name of the company.
   */
  'CompanyLegalName'?: string;
  /**
   * The country or region imposing the tax.
   */
  'TaxingRegion'?: string;
  /**
   * A list of tax classifications that apply to the order.
   */
  'TaxClassifications'?: Array<TaxClassification>;
}
//#endregion
//#region src/api-model/models/buyer-info.d.ts
/**
 * Buyer information.
 */
interface BuyerInfo {
  /**
   * The anonymized email address of the buyer.
   */
  'BuyerEmail'?: string;
  /**
   * The buyer name or the recipient name.
   */
  'BuyerName'?: string;
  /**
   * The county of the buyer.  **Note**: This attribute is only available in the Brazil marketplace.
   */
  'BuyerCounty'?: string;
  '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.
   */
  'PurchaseOrderNumber'?: string;
}
//#endregion
//#region src/api-model/models/buyer-requested-cancel.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Information about whether or not a buyer requested cancellation.
 */
interface BuyerRequestedCancel {
  /**
   * Indicate whether the buyer has requested cancellation.  **Possible Values**: `true`, `false`.
   */
  'IsBuyerRequestedCancel'?: string;
  /**
   * The reason that the buyer requested cancellation.
   */
  'BuyerCancelReason'?: string;
}
//#endregion
//#region src/api-model/models/buyer-tax-information.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Contains the business invoice tax information. Available only in the TR marketplace.
 */
interface BuyerTaxInformation {
  /**
   * Business buyer\'s company legal name.
   */
  'BuyerLegalCompanyName'?: string;
  /**
   * Business buyer\'s address.
   */
  'BuyerBusinessAddress'?: string;
  /**
   * Business buyer\'s tax registration ID.
   */
  'BuyerTaxRegistrationId'?: string;
  /**
   * Business buyer\'s tax office.
   */
  'BuyerTaxOffice'?: string;
}
//#endregion
//#region src/api-model/models/confirm-shipment-error-response.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * The error response schema for the `confirmShipment` operation.
 */
interface ConfirmShipmentErrorResponse {
  /**
   * A list of error responses returned when a request is unsuccessful.
   */
  'errors'?: Array<Error>;
}
//#endregion
//#region src/api-model/models/confirm-shipment-order-item.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * A single order item.
 */
interface ConfirmShipmentOrderItem {
  /**
   * The order item\'s unique identifier.
   */
  'orderItemId': string;
  /**
   * The item\'s quantity.
   */
  'quantity': number;
  /**
   * A list of order items.
   */
  'transparencyCodes'?: Array<string>;
}
//#endregion
//#region src/api-model/models/package-detail.d.ts
/**
 * Properties of packages
 */
interface PackageDetail {
  /**
   * A seller-supplied identifier that uniquely identifies a package within the scope of an order. Only positive numeric values are supported.
   */
  '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).
   */
  'carrierCode': string;
  /**
   * Carrier name that will deliver the package. Required when `carrierCode` is \"Other\"
   */
  'carrierName'?: string;
  /**
   * Ship method to be used for shipping the order.
   */
  'shippingMethod'?: string;
  /**
   * The tracking number used to obtain tracking and delivery information.
   */
  'trackingNumber': string;
  /**
   * The shipping date for the package. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
   */
  'shipDate': string;
  /**
   * The unique identifier for the supply source.
   */
  'shipFromSupplySourceId'?: string;
  /**
   * A list of order items.
   */
  'orderItems': Array<ConfirmShipmentOrderItem>;
}
//#endregion
//#region src/api-model/models/confirm-shipment-request.d.ts
/**
 * The request schema for an shipment confirmation.
 */
interface ConfirmShipmentRequest {
  'packageDetail': PackageDetail;
  /**
   * The COD collection method (only supported in the JP marketplace).
   */
  'codCollectionMethod'?: ConfirmShipmentRequestCodCollectionMethodEnum;
  /**
   * The unobfuscated marketplace identifier.
   */
  'marketplaceId': string;
}
declare const ConfirmShipmentRequestCodCollectionMethodEnum: {
  readonly DirectPayment: "DirectPayment";
};
type ConfirmShipmentRequestCodCollectionMethodEnum = typeof ConfirmShipmentRequestCodCollectionMethodEnum[keyof typeof ConfirmShipmentRequestCodCollectionMethodEnum];
//#endregion
//#region src/api-model/models/constraint-type.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Details the importance of the constraint present on the item
 */
declare const ConstraintType: {
  readonly Mandatory: "MANDATORY";
};
type ConstraintType = typeof ConstraintType[keyof typeof ConstraintType];
//#endregion
//#region src/api-model/models/other-delivery-attributes.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Miscellaneous delivery attributes associated with the shipping address.
 */
declare const OtherDeliveryAttributes: {
  readonly HasAccessPoint: "HAS_ACCESS_POINT";
  readonly PalletEnabled: "PALLET_ENABLED";
  readonly PalletDisabled: "PALLET_DISABLED";
};
type OtherDeliveryAttributes = typeof OtherDeliveryAttributes[keyof typeof OtherDeliveryAttributes];
//#endregion
//#region src/api-model/models/exception-dates.d.ts
/**
 * Dates when the business is closed or open with a different time window.
 */
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.
   */
  'ExceptionDate'?: string;
  /**
   * Boolean indicating if the business is closed or open on that date.
   */
  'IsOpen'?: boolean;
  /**
   * Time window during the day when the business is open.
   */
  'OpenIntervals'?: Array<OpenInterval>;
}
//#endregion
//#region src/api-model/models/preferred-delivery-time.d.ts
/**
 * The time window when the delivery is preferred.
 */
interface PreferredDeliveryTime {
  /**
   * Business hours when the business is open for deliveries.
   */
  'BusinessHours'?: Array<BusinessHours>;
  /**
   * Dates when the business is closed during the next 30 days.
   */
  'ExceptionDates'?: Array<ExceptionDates>;
}
//#endregion
//#region src/api-model/models/delivery-preferences.d.ts
/**
 * Contains all of the delivery instructions provided by the customer for the shipping address.
 */
interface DeliveryPreferences {
  /**
   * Drop-off location selected by the customer.
   */
  'DropOffLocation'?: string;
  'PreferredDeliveryTime'?: PreferredDeliveryTime;
  /**
   * Enumerated list of miscellaneous delivery attributes associated with the shipping address.
   */
  'OtherAttributes'?: Array<OtherDeliveryAttributes>;
  /**
   * Building instructions, nearby landmark or navigation instructions.
   */
  'AddressInstructions'?: string;
}
//#endregion
//#region src/api-model/models/easy-ship-shipment-status.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.
 */
declare const EasyShipShipmentStatus: {
  readonly PendingSchedule: "PendingSchedule";
  readonly PendingPickUp: "PendingPickUp";
  readonly PendingDropOff: "PendingDropOff";
  readonly LabelCanceled: "LabelCanceled";
  readonly PickedUp: "PickedUp";
  readonly DroppedOff: "DroppedOff";
  readonly AtOriginFc: "AtOriginFC";
  readonly AtDestinationFc: "AtDestinationFC";
  readonly Delivered: "Delivered";
  readonly RejectedByBuyer: "RejectedByBuyer";
  readonly Undeliverable: "Undeliverable";
  readonly ReturningToSeller: "ReturningToSeller";
  readonly ReturnedToSeller: "ReturnedToSeller";
  readonly Lost: "Lost";
  readonly OutForDelivery: "OutForDelivery";
  readonly Damaged: "Damaged";
};
type EasyShipShipmentStatus = typeof EasyShipShipmentStatus[keyof typeof EasyShipShipmentStatus];
//#endregion
//#region src/api-model/models/electronic-invoice-status.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * The status of the electronic invoice. Only available for Easy Ship orders and orders in the BR marketplace.
 */
declare const ElectronicInvoiceStatus: {
  readonly NotRequired: "NotRequired";
  readonly NotFound: "NotFound";
  readonly Processing: "Processing";
  readonly Errored: "Errored";
  readonly Accepted: "Accepted";
};
type ElectronicInvoiceStatus = typeof ElectronicInvoiceStatus[keyof typeof ElectronicInvoiceStatus];
//#endregion
//#region src/api-model/models/fulfillment-instruction.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Contains the instructions about the fulfillment, such as the location from where you want the order filled.
 */
interface FulfillmentInstruction {
  /**
   * The `sourceId` of the location from where you want the order fulfilled.
   */
  'FulfillmentSupplySourceId'?: string;
}
//#endregion
//#region src/api-model/models/order-address.d.ts
/**
 * The shipping address for the order.
 */
interface OrderAddress {
  /**
   * An Amazon-defined order identifier, in 3-7-7 format.
   */
  'AmazonOrderId': string;
  /**
   * The company name of the contact buyer. For IBA orders, the buyer company must be Amazon entities.
   */
  'BuyerCompanyName'?: string;
  'ShippingAddress'?: Address;
  'DeliveryPreferences'?: DeliveryPreferences;
}
//#endregion
//#region src/api-model/models/get-order-address-response.d.ts
/**
 * The response schema for the `getOrderAddress` operation.
 */
interface GetOrderAddressResponse {
  'payload'?: OrderAddress;
  /**
   * A list of error responses returned when a request is unsuccessful.
   */
  'errors'?: Array<Error>;
}
//#endregion
//#region src/api-model/models/order-buyer-info.d.ts
/**
 * Buyer information for an order.
 */
interface OrderBuyerInfo {
  /**
   * An Amazon-defined order identifier, in 3-7-7 format.
   */
  'AmazonOrderId': string;
  /**
   * The anonymized email address of the buyer.
   */
  'BuyerEmail'?: string;
  /**
   * The buyer name or the recipient name.
   */
  'BuyerName'?: string;
  /**
   * The county of the buyer.  **Note**: This attribute is only available in the Brazil marketplace.
   */
  'BuyerCounty'?: string;
  '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.
   */
  'PurchaseOrderNumber'?: string;
}
//#endregion
//#region src/api-model/models/get-order-buyer-info-response.d.ts
/**
 * The response schema for the `getOrderBuyerInfo` operation.
 */
interface GetOrderBuyerInfoResponse {
  'payload'?: OrderBuyerInfo;
  /**
   * A list of error responses returned when a request is unsuccessful.
   */
  'errors'?: Array<Error>;
}
//#endregion
//#region src/api-model/models/money.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * The monetary value of the order.
 */
interface Money {
  /**
   * The three-digit currency code. In ISO 4217 format.
   */
  'CurrencyCode'?: string;
  /**
   * The currency amount.
   */
  'Amount'?: string;
}
//#endregion
//#region src/api-model/models/order-item-buyer-info.d.ts
/**
 * A single order item\'s buyer information.
 */
interface OrderItemBuyerInfo {
  /**
   * An Amazon-defined order item identifier.
   */
  'OrderItemId': string;
  'BuyerCustomizedInfo'?: BuyerCustomizedInfoDetail;
  'GiftWrapPrice'?: Money;
  'GiftWrapTax'?: Money;
  /**
   * A gift message provided by the buyer.  **Note**: This attribute is only available for MFN (fulfilled by seller) orders.
   */
  'GiftMessageText'?: string;
  /**
   * The gift wrap level specified by the buyer.
   */
  'GiftWrapLevel'?: string;
}
//#endregion
//#region src/api-model/models/order-items-buyer-info-list.d.ts
/**
 * A single order item\'s buyer information list with the order ID.
 */
interface OrderItemsBuyerInfoList {
  /**
   * A single order item\'s buyer information list.
   */
  'OrderItems': Array<OrderItemBuyerInfo>;
  /**
   * When present and not empty, pass this string token in the next request to return the next response page.
   */
  'NextToken'?: string;
  /**
   * An Amazon-defined order identifier, in 3-7-7 format.
   */
  'AmazonOrderId': string;
}
//#endregion
//#region src/api-model/models/get-order-items-buyer-info-response.d.ts
/**
 * The response schema for the `getOrderItemsBuyerInfo` operation.
 */
interface GetOrderItemsBuyerInfoResponse {
  'payload'?: OrderItemsBuyerInfoList;
  /**
   * A list of error responses returned when a request is unsuccessful.
   */
  'errors'?: Array<Error>;
}
//#endregion
//#region src/api-model/models/item-buyer-info.d.ts
/**
 * A single item\'s buyer information.
 */
interface ItemBuyerInfo {
  'BuyerCustomizedInfo'?: BuyerCustomizedInfoDetail;
  'GiftWrapPrice'?: Money;
  'GiftWrapTax'?: Money;
  /**
   * A gift message provided by the buyer.  **Note**: This attribute is only available for MFN (fulfilled by seller) orders.
   */
  'GiftMessageText'?: string;
  /**
   * The gift wrap level specified by the buyer.
   */
  'GiftWrapLevel'?: string;
}
//#endregion
//#region src/api-model/models/measurement.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Measurement information for an order item.
 */
interface Measurement {
  /**
   * The unit of measure.
   */
  'Unit': MeasurementUnitEnum;
  /**
   * The measurement value.
   */
  'Value': number;
}
declare const MeasurementUnitEnum: {
  readonly Ounces: "OUNCES";
  readonly Pounds: "POUNDS";
  readonly Kilograms: "KILOGRAMS";
  readonly Grams: "GRAMS";
  readonly Milligrams: "MILLIGRAMS";
  readonly Inches: "INCHES";
  readonly Feet: "FEET";
  readonly Meters: "METERS";
  readonly Centimeters: "CENTIMETERS";
  readonly Millimeters: "MILLIMETERS";
  readonly SquareMeters: "SQUARE_METERS";
  readonly SquareCentimeters: "SQUARE_CENTIMETERS";
  readonly SquareFeet: "SQUARE_FEET";
  readonly SquareInches: "SQUARE_INCHES";
  readonly Gallons: "GALLONS";
  readonly Pints: "PINTS";
  readonly Quarts: "QUARTS";
  readonly FluidOunces: "FLUID_OUNCES";
  readonly Liters: "LITERS";
  readonly CubicMeters: "CUBIC_METERS";
  readonly CubicFeet: "CUBIC_FEET";
  readonly CubicInches: "CUBIC_INCHES";
  readonly CubicCentimeters: "CUBIC_CENTIMETERS";
  readonly Count: "COUNT";
};
type MeasurementUnitEnum = typeof MeasurementUnitEnum[keyof typeof MeasurementUnitEnum];
//#endregion
//#region src/api-model/models/points-granted-detail.d.ts
/**
 * The number of Amazon Points offered with the purchase of an item, and their monetary value.
 */
interface PointsGrantedDetail {
  /**
   * The number of Amazon Points granted with the purchase of an item.
   */
  'PointsNumber'?: number;
  'PointsMonetaryValue'?: Money;
}
//#endregion
//#region src/api-model/models/product-info-detail.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Product information on the number of items.
 */
interface ProductInfoDetail {
  /**
   * The total number of items that are included in the ASIN.
   */
  'NumberOfItems'?: string;
}
//#endregion
//#region src/api-model/models/shipping-constraints.d.ts
/**
 * Delivery constraints applicable to this order.
 */
interface ShippingConstraints {
  'PalletDelivery'?: ConstraintType;
  'SignatureConfirmation'?: ConstraintType;
  'RecipientIdentityVerification'?: ConstraintType;
  'RecipientAgeVerification'?: ConstraintType;
}
//#endregion
//#region src/api-model/models/substitution-option.d.ts
/**
 * Substitution options for an order item.
 */
interface SubstitutionOption {
  /**
   * The item\'s Amazon Standard Identification Number (ASIN).
   */
  'ASIN'?: string;
  /**
   * The number of items to be picked for this substitution option.
   */
  'QuantityOrdered'?: number;
  /**
   * The item\'s seller stock keeping unit (SKU).
   */
  'SellerSKU'?: string;
  /**
   * The item\'s title.
   */
  'Title'?: string;
  'Measurement'?: Measurement;
}
//#endregion
//#region src/api-model/models/substitution-preferences.d.ts
/**
 * Substitution preferences for an order item.
 */
interface SubstitutionPreferences {
  /**
   * The type of substitution that these preferences represent.
   */
  'SubstitutionType': SubstitutionPreferencesSubstitutionTypeEnum;
  /**
   * A collection of substitution options.
   */
  'SubstitutionOptions'?: Array<SubstitutionOption>;
}
declare const SubstitutionPreferencesSubstitutionTypeEnum: {
  readonly CustomerPreference: "CUSTOMER_PREFERENCE";
  readonly AmazonRecommended: "AMAZON_RECOMMENDED";
  readonly DoNotSubstitute: "DO_NOT_SUBSTITUTE";
};
type SubstitutionPreferencesSubstitutionTypeEnum = typeof SubstitutionPreferencesSubstitutionTypeEnum[keyof typeof SubstitutionPreferencesSubstitutionTypeEnum];
//#endregion
//#region src/api-model/models/tax-collection.d.ts
/**
 * Selling Partner API for Orders
 * 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.
 */
/**
 * Information about withheld taxes.
 */
interface TaxCollection {
  /**
   * The tax collection model applied to the item.
   */
  'Model'?: TaxCollectionModelEnum;
  /**
   * The party responsible for withholding the taxes and remitting them to the taxing authority.
   */
  'ResponsibleParty'?: TaxCollectionResponsiblePartyEnum;
}
declare const TaxCollectionModelEnum: {
  readonly MarketplaceFacilitator: "MarketplaceFacilitator";
};
type TaxCollectionModelEnum = typeof TaxCollectionModelEnum[keyof typeof TaxCollectionModelEnum];
declare const TaxCollectionResponsiblePartyEnum: {
  readonly AmazonServicesInc: "Amazon Services, Inc.";
};
type TaxCollectionResponsiblePartyEnum = typeof TaxCollectionResponsiblePartyEnum[keyof typeof TaxCollectionResponsiblePartyEnum];
//#endregion
//#region src/api-model/models/order-item.d.ts
/**
 * A single order item.
 */
interface OrderItem {
  /**
   * The item\'s Amazon Standard Identification Number (ASIN).
   */
  'ASIN': string;
  /**
   * The item\'s seller stock keeping unit (SKU).
   */
  'SellerSKU'?: string;
  /**
   * An Amazon-defined order item identifier.
   */
  'OrderItemId': string;
  /**
   * A list of associated items that a customer has purchased with a product. For example, a tire installation service purchased with tires.
   */
  'AssociatedItems'?: Array<AssociatedItem>;
  /**
   * The item\'s name.
   */
  'Title'?: string;
  /**
   * The number of items in the order.
   */
  'QuantityOrdered': number;
  /**
   * The number of items shipped.
   */
  'QuantityShipped'?: number;
  'ProductInfo'?: ProductInfoDetail;
  'PointsGranted'?: PointsGrantedDetail;
  'ItemPrice'?: Money;
  'ShippingPrice'?: Money;
  'ItemTax'?: Money;
  'ShippingTax'?: Money;
  'ShippingDiscount'?: Money;
  'ShippingDiscountTax'?: Money;
  'PromotionDiscount'?: Money;
  'PromotionDiscountTax'?: Money;
  /**
   * A list of promotion identifiers provided by the seller when the promotions were created.
   */
  'PromotionIds'?: Array<string>;
  'CODFee'?: Money;
  'CODFeeDiscount'?: Money;
  /**
   * Indicates whether the item is a gift.  **Possible values**: `true` and `false`.
   */
  'IsGift'?: string;
  /**
   * The condition of the item, as described by the seller.
   */
  'ConditionNote'?: string;
  /**
   * The condition of the item.  **Possible values**: `New`, `Used`, `Collectible`, `Refurbished`, `Preorder`, and `Club`.
   */
  '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`.
   */
  '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.
   */
  '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.
   */
  '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`
   */
  'PriceDesignation'?: string;
  'TaxCollection'?: TaxCollection;
  /**
   * When true, the product type for this item has a serial number.   Only returned for Amazon Easy Ship orders.
   */
  '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.
   */
  '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.
   */
  'IossNumber'?: string;
  /**
   * The store chain store identifier. Linked to a specific store in a store chain.
   */
  '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.
   */
  'DeemedResellerCategory'?: OrderItemDeemedResellerCategoryEnum;
  'BuyerInfo'?: ItemBuyerInfo;
  'BuyerRequestedCancel'?: BuyerRequestedCancel;
  /**
   * A list of serial numbers for electronic products that are shipped to customers. Returned for FBA orders only.
   */
  'SerialNumbers'?: Array<string>;
  'SubstitutionPreferences'?: SubstitutionPreferences;
  'Measurement'?: Measurement;
  'ShippingConstraints'?: ShippingConstraints;
  'AmazonPrograms'?: AmazonPrograms;
}
declare const OrderItemDeemedResellerCategoryEnum: {
  readonly Ioss: "IOSS";
  readonly Uoss: "UOSS";
};
type OrderItemDeemedResellerCategoryEnum = typeof OrderItemDeemedResellerCategoryEnum[keyof typeof OrderItemDeemedResellerCategoryEnum];
//#endregion
//#region src/api-model/models/order-items-list.d.ts
/**
 * The order items list along with the order ID.
 */
interface OrderItemsList {
  /**
   * A list of order items.
   */
  'OrderItems': Array<OrderItem>;
  /**
   * When present and not empty, pass this string token in the next request to return the next response page.
   */
  'NextToken'?: string;
  /**
   * An Amazon-defined order identif