/** * Selling Partner API for Easy Ship * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace. * * The version of the OpenAPI document: 2022-03-23 * * * 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'; /** * An error code that identifies the type of error that occurred. The error codes listed below are specific to the Easy Ship section. * @export * @enum {string} */ export declare enum Code { InvalidInput = "InvalidInput", InvalidTimeSlotId = "InvalidTimeSlotId", ScheduledPackageAlreadyExists = "ScheduledPackageAlreadyExists", ScheduleWindowExpired = "ScheduleWindowExpired", RetryableAfterGettingNewSlots = "RetryableAfterGettingNewSlots", TimeSlotNotAvailable = "TimeSlotNotAvailable", ResourceNotFound = "ResourceNotFound", InvalidOrderState = "InvalidOrderState", RegionNotSupported = "RegionNotSupported", OrderNotEligibleForRescheduling = "OrderNotEligibleForRescheduling", InternalServerError = "InternalServerError" } /** * The request schema for the `createScheduledPackage` operation. * @export * @interface CreateScheduledPackageRequest */ export interface CreateScheduledPackageRequest { /** * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. * @type {string} * @memberof CreateScheduledPackageRequest */ amazonOrderId: string; /** * A string of up to 255 characters. * @type {string} * @memberof CreateScheduledPackageRequest */ marketplaceId: string; /** * * @type {PackageDetails} * @memberof CreateScheduledPackageRequest */ packageDetails: PackageDetails; } /** * The request body for the POST /easyShip/2022-03-23/packages/bulk API. * @export * @interface CreateScheduledPackagesRequest */ export interface CreateScheduledPackagesRequest { /** * A string of up to 255 characters. * @type {string} * @memberof CreateScheduledPackagesRequest */ marketplaceId: string; /** * An array allowing users to specify orders to be scheduled. * @type {Array} * @memberof CreateScheduledPackagesRequest */ orderScheduleDetailsList: Array; /** * * @type {LabelFormat} * @memberof CreateScheduledPackagesRequest */ labelFormat: LabelFormat | 'PDF' | 'ZPL'; } /** * The response schema for the bulk scheduling API. It returns by the bulk scheduling API containing an array of the scheduled packtages, an optional list of orders we couldn\'t schedule with the reason, and a pre-signed URL for a ZIP file containing the associated shipping labels plus the documents enabled for your marketplace. * @export * @interface CreateScheduledPackagesResponse */ export interface CreateScheduledPackagesResponse { /** * A list of packages. Refer to the `Package` object. * @type {Array} * @memberof CreateScheduledPackagesResponse */ scheduledPackages?: Array; /** * A list of orders we couldn\'t scheduled on your behalf. Each element contains the reason and details on the error. * @type {Array} * @memberof CreateScheduledPackagesResponse */ rejectedOrders?: Array; /** * A pre-signed URL for the zip document containing the shipping labels and the documents enabled for your marketplace. * @type {string} * @memberof CreateScheduledPackagesResponse */ printableDocumentsUrl?: string; } /** * The dimensions of the scheduled package. * @export * @interface Dimensions */ export interface Dimensions { /** * The numerical value of the specified dimension. * @type {number} * @memberof Dimensions */ length?: number; /** * The numerical value of the specified dimension. * @type {number} * @memberof Dimensions */ width?: number; /** * The numerical value of the specified dimension. * @type {number} * @memberof Dimensions */ height?: number; /** * * @type {UnitOfLength} * @memberof Dimensions */ unit?: UnitOfLength | 'Cm'; /** * A string of up to 255 characters. * @type {string} * @memberof Dimensions */ identifier?: string; } /** * A list of error responses returned when a request is unsuccessful. * @export * @interface ErrorList */ export interface ErrorList { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof ErrorList */ errors: Array; } /** * Identifies the method by which a seller will hand a package over to Amazon Logistics. * @export * @enum {string} */ export declare enum HandoverMethod { Pickup = "Pickup", Dropoff = "Dropoff" } /** * Invoice number and date. * @export * @interface InvoiceData */ export interface InvoiceData { /** * A string of up to 255 characters. * @type {string} * @memberof InvoiceData */ invoiceNumber: string; /** * A datetime value in ISO 8601 format. * @type {string} * @memberof InvoiceData */ invoiceDate?: string; } /** * Item identifier and serial number information. * @export * @interface Item */ export interface Item { /** * The Amazon-defined order item identifier. * @type {string} * @memberof Item */ orderItemId?: string; /** * A list of serial numbers for the items associated with the `OrderItemId` value. * @type {Array} * @memberof Item */ orderItemSerialNumbers?: Array; } /** * The file format in which the shipping label will be created. * @export * @enum {string} */ export declare enum LabelFormat { Pdf = "PDF", Zpl = "ZPL" } /** * The request schema for the `listHandoverSlots` operation. * @export * @interface ListHandoverSlotsRequest */ export interface ListHandoverSlotsRequest { /** * A string of up to 255 characters. * @type {string} * @memberof ListHandoverSlotsRequest */ marketplaceId: string; /** * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. * @type {string} * @memberof ListHandoverSlotsRequest */ amazonOrderId: string; /** * * @type {Dimensions} * @memberof ListHandoverSlotsRequest */ packageDimensions: Dimensions; /** * * @type {Weight} * @memberof ListHandoverSlotsRequest */ packageWeight: Weight; } /** * The response schema for the `listHandoverSlots` operation. * @export * @interface ListHandoverSlotsResponse */ export interface ListHandoverSlotsResponse { /** * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. * @type {string} * @memberof ListHandoverSlotsResponse */ amazonOrderId: string; /** * A list of time slots. * @type {Array} * @memberof ListHandoverSlotsResponse */ timeSlots: Array; } /** * 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; } /** * This object allows users to specify an order to be scheduled. Only the amazonOrderId is required. * @export * @interface OrderScheduleDetails */ export interface OrderScheduleDetails { /** * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. * @type {string} * @memberof OrderScheduleDetails */ amazonOrderId: string; /** * * @type {PackageDetails} * @memberof OrderScheduleDetails */ packageDetails?: PackageDetails; } /** * This object contains all the details of the scheduled Easy Ship package. * @export * @interface Package */ export interface Package { /** * * @type {ScheduledPackageId} * @memberof Package */ scheduledPackageId: ScheduledPackageId; /** * * @type {Dimensions} * @memberof Package */ packageDimensions: Dimensions; /** * * @type {Weight} * @memberof Package */ packageWeight: Weight; /** * A list of items contained in the package. * @type {Array} * @memberof Package */ packageItems?: Array; /** * * @type {TimeSlot} * @memberof Package */ packageTimeSlot: TimeSlot; /** * Optional seller-created identifier that is printed on the shipping label to help the seller identify the package. * @type {string} * @memberof Package */ packageIdentifier?: string; /** * * @type {InvoiceData} * @memberof Package */ invoice?: InvoiceData; /** * * @type {PackageStatus} * @memberof Package */ packageStatus?: PackageStatus | 'ReadyForPickup' | 'PickedUp' | 'AtOriginFC' | 'AtDestinationFC' | 'Delivered' | 'Rejected' | 'Undeliverable' | 'ReturnedToSeller' | 'LostInTransit' | 'LabelCanceled' | 'DamagedInTransit' | 'OutForDelivery'; /** * * @type {TrackingDetails} * @memberof Package */ trackingDetails?: TrackingDetails; } /** * Package details. Includes `packageItems`, `packageTimeSlot`, and `packageIdentifier`. * @export * @interface PackageDetails */ export interface PackageDetails { /** * A list of items contained in the package. * @type {Array} * @memberof PackageDetails */ packageItems?: Array; /** * * @type {TimeSlot} * @memberof PackageDetails */ packageTimeSlot: TimeSlot; /** * Optional seller-created identifier that is printed on the shipping label to help the seller identify the package. * @type {string} * @memberof PackageDetails */ packageIdentifier?: string; } /** * The status of the package. * @export * @enum {string} */ export declare enum PackageStatus { ReadyForPickup = "ReadyForPickup", PickedUp = "PickedUp", AtOriginFc = "AtOriginFC", AtDestinationFc = "AtDestinationFC", Delivered = "Delivered", Rejected = "Rejected", Undeliverable = "Undeliverable", ReturnedToSeller = "ReturnedToSeller", LostInTransit = "LostInTransit", LabelCanceled = "LabelCanceled", DamagedInTransit = "DamagedInTransit", OutForDelivery = "OutForDelivery" } /** * A list of packages. * @export * @interface Packages */ export interface Packages { /** * A list of packages. * @type {Array} * @memberof Packages */ packages: Array; } /** * A order which we couldn\'t schedule on your behalf. It contains its id, and information on the error. * @export * @interface RejectedOrder */ export interface RejectedOrder { /** * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. * @type {string} * @memberof RejectedOrder */ amazonOrderId: string; /** * * @type {Error} * @memberof RejectedOrder */ error?: Error; } /** * Identifies the scheduled package to be updated. * @export * @interface ScheduledPackageId */ export interface ScheduledPackageId { /** * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. * @type {string} * @memberof ScheduledPackageId */ amazonOrderId: string; /** * An Amazon-defined identifier for the scheduled package. * @type {string} * @memberof ScheduledPackageId */ packageId?: string; } /** * A time window to hand over an Easy Ship package to Amazon Logistics. * @export * @interface TimeSlot */ export interface TimeSlot { /** * A string of up to 255 characters. * @type {string} * @memberof TimeSlot */ slotId: string; /** * A datetime value in ISO 8601 format. * @type {string} * @memberof TimeSlot */ startTime?: string; /** * A datetime value in ISO 8601 format. * @type {string} * @memberof TimeSlot */ endTime?: string; /** * * @type {HandoverMethod} * @memberof TimeSlot */ handoverMethod?: HandoverMethod | 'Pickup' | 'Dropoff'; } /** * Representation of tracking metadata. * @export * @interface TrackingDetails */ export interface TrackingDetails { /** * A string of up to 255 characters. * @type {string} * @memberof TrackingDetails */ trackingId?: string; } /** * The unit of measurement used to measure the length. * @export * @enum {string} */ export declare enum UnitOfLength { Cm = "Cm" } /** * The unit of measurement used to measure the weight. * @export * @enum {string} */ export declare enum UnitOfWeight { Grams = "Grams", G = "G" } /** * Request to update the time slot of a package. * @export * @interface UpdatePackageDetails */ export interface UpdatePackageDetails { /** * * @type {ScheduledPackageId} * @memberof UpdatePackageDetails */ scheduledPackageId: ScheduledPackageId; /** * * @type {TimeSlot} * @memberof UpdatePackageDetails */ packageTimeSlot: TimeSlot; } /** * The request schema for the `updateScheduledPackages` operation. * @export * @interface UpdateScheduledPackagesRequest */ export interface UpdateScheduledPackagesRequest { /** * A string of up to 255 characters. * @type {string} * @memberof UpdateScheduledPackagesRequest */ marketplaceId: string; /** * A list of package update details. * @type {Array} * @memberof UpdateScheduledPackagesRequest */ updatePackageDetailsList: Array; } /** * The weight of the scheduled package * @export * @interface Weight */ export interface Weight { /** * The weight of the package. * @type {number} * @memberof Weight */ value?: number; /** * * @type {UnitOfWeight} * @memberof Weight */ unit?: UnitOfWeight | 'Grams' | 'G'; } /** * EasyShipApi - axios parameter creator * @export */ export declare const EasyShipApiAxiosParamCreator: (configuration?: Configuration) => { /** * Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: * Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a warranty document if you specify a `SerialNumber` value. To get these documents, see [How to get invoice, shipping label, and warranty documents](doc:easyship-api-v2022-03-23-use-case-guide). * Shows the status of Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and **Warranty** columns in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which documents are supported in each marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the `createScheduledPackage` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createScheduledPackage: (createScheduledPackageRequest: CreateScheduledPackageRequest, options?: any) => Promise; /** * This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createScheduledPackageBulk: (createScheduledPackagesRequest: CreateScheduledPackagesRequest, options?: any) => Promise; /** * Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. * @param {string} marketplaceId An identifier for the marketplace in which the seller is selling. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getScheduledPackage: (amazonOrderId: string, marketplaceId: string, options?: any) => Promise; /** * Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace support. See **Get Time Slots** in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). This operation can return time slots that have either pickup or drop-off handover methods - see **Supported Handover Methods** in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the `listHandoverSlots` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listHandoverSlots: (listHandoverSlotsRequest?: ListHandoverSlotsRequest, options?: any) => Promise; /** * Updates the time slot for handing over the package indicated by the specified `scheduledPackageId`. You can get the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another `patch` call. See the **Update Package** column in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which marketplaces this operation is supported in. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the `updateScheduledPackages` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateScheduledPackages: (updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest, options?: any) => Promise; }; /** * EasyShipApi - functional programming interface * @export */ export declare const EasyShipApiFp: (configuration?: Configuration) => { /** * Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: * Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a warranty document if you specify a `SerialNumber` value. To get these documents, see [How to get invoice, shipping label, and warranty documents](doc:easyship-api-v2022-03-23-use-case-guide). * Shows the status of Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and **Warranty** columns in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which documents are supported in each marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the `createScheduledPackage` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createScheduledPackage(createScheduledPackageRequest: CreateScheduledPackageRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createScheduledPackageBulk(createScheduledPackagesRequest: CreateScheduledPackagesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. * @param {string} marketplaceId An identifier for the marketplace in which the seller is selling. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getScheduledPackage(amazonOrderId: string, marketplaceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace support. See **Get Time Slots** in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). This operation can return time slots that have either pickup or drop-off handover methods - see **Supported Handover Methods** in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the `listHandoverSlots` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listHandoverSlots(listHandoverSlotsRequest?: ListHandoverSlotsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the time slot for handing over the package indicated by the specified `scheduledPackageId`. You can get the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another `patch` call. See the **Update Package** column in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which marketplaces this operation is supported in. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the `updateScheduledPackages` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateScheduledPackages(updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EasyShipApi - factory interface * @export */ export declare const EasyShipApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: * Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a warranty document if you specify a `SerialNumber` value. To get these documents, see [How to get invoice, shipping label, and warranty documents](doc:easyship-api-v2022-03-23-use-case-guide). * Shows the status of Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and **Warranty** columns in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which documents are supported in each marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateScheduledPackageRequest} createScheduledPackageRequest The request schema for the `createScheduledPackage` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createScheduledPackage(createScheduledPackageRequest: CreateScheduledPackageRequest, options?: any): AxiosPromise; /** * This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateScheduledPackagesRequest} createScheduledPackagesRequest The request schema for the `createScheduledPackageBulk` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createScheduledPackageBulk(createScheduledPackagesRequest: CreateScheduledPackagesRequest, options?: any): AxiosPromise; /** * Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {string} amazonOrderId An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. * @param {string} marketplaceId An identifier for the marketplace in which the seller is selling. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getScheduledPackage(amazonOrderId: string, marketplaceId: string, options?: any): AxiosPromise; /** * Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace support. See **Get Time Slots** in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). This operation can return time slots that have either pickup or drop-off handover methods - see **Supported Handover Methods** in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {ListHandoverSlotsRequest} [listHandoverSlotsRequest] The request schema for the `listHandoverSlots` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listHandoverSlots(listHandoverSlotsRequest?: ListHandoverSlotsRequest, options?: any): AxiosPromise; /** * Updates the time slot for handing over the package indicated by the specified `scheduledPackageId`. You can get the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another `patch` call. See the **Update Package** column in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which marketplaces this operation is supported in. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {UpdateScheduledPackagesRequest} [updateScheduledPackagesRequest] The request schema for the `updateScheduledPackages` operation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateScheduledPackages(updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest, options?: any): AxiosPromise; }; /** * Request parameters for createScheduledPackage operation in EasyShipApi. * @export * @interface EasyShipApiCreateScheduledPackageRequest */ export interface EasyShipApiCreateScheduledPackageRequest { /** * The request schema for the `createScheduledPackage` operation. * @type {CreateScheduledPackageRequest} * @memberof EasyShipApiCreateScheduledPackage */ readonly createScheduledPackageRequest: CreateScheduledPackageRequest; } /** * Request parameters for createScheduledPackageBulk operation in EasyShipApi. * @export * @interface EasyShipApiCreateScheduledPackageBulkRequest */ export interface EasyShipApiCreateScheduledPackageBulkRequest { /** * The request schema for the `createScheduledPackageBulk` operation. * @type {CreateScheduledPackagesRequest} * @memberof EasyShipApiCreateScheduledPackageBulk */ readonly createScheduledPackagesRequest: CreateScheduledPackagesRequest; } /** * Request parameters for getScheduledPackage operation in EasyShipApi. * @export * @interface EasyShipApiGetScheduledPackageRequest */ export interface EasyShipApiGetScheduledPackageRequest { /** * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship. * @type {string} * @memberof EasyShipApiGetScheduledPackage */ readonly amazonOrderId: string; /** * An identifier for the marketplace in which the seller is selling. * @type {string} * @memberof EasyShipApiGetScheduledPackage */ readonly marketplaceId: string; } /** * Request parameters for listHandoverSlots operation in EasyShipApi. * @export * @interface EasyShipApiListHandoverSlotsRequest */ export interface EasyShipApiListHandoverSlotsRequest { /** * The request schema for the `listHandoverSlots` operation. * @type {ListHandoverSlotsRequest} * @memberof EasyShipApiListHandoverSlots */ readonly listHandoverSlotsRequest?: ListHandoverSlotsRequest; } /** * Request parameters for updateScheduledPackages operation in EasyShipApi. * @export * @interface EasyShipApiUpdateScheduledPackagesRequest */ export interface EasyShipApiUpdateScheduledPackagesRequest { /** * The request schema for the `updateScheduledPackages` operation. * @type {UpdateScheduledPackagesRequest} * @memberof EasyShipApiUpdateScheduledPackages */ readonly updateScheduledPackagesRequest?: UpdateScheduledPackagesRequest; } /** * EasyShipApi - object-oriented interface * @export * @class EasyShipApi * @extends {BaseAPI} */ export declare class EasyShipApi extends BaseAPI { /** * Schedules an Easy Ship order and returns the scheduled package information. This operation does the following: * Specifies the time slot and handover method for the order to be scheduled for delivery. * Updates the Easy Ship order status. * Generates a shipping label and an invoice. Calling `createScheduledPackage` also generates a warranty document if you specify a `SerialNumber` value. To get these documents, see [How to get invoice, shipping label, and warranty documents](doc:easyship-api-v2022-03-23-use-case-guide). * Shows the status of Easy Ship orders when you call the `getOrders` operation of the Selling Partner API for Orders and examine the `EasyShipShipmentStatus` property in the response body. See the **Shipping Label**, **Invoice**, and **Warranty** columns in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which documents are supported in each marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {EasyShipApiCreateScheduledPackageRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EasyShipApi */ createScheduledPackage(requestParameters: EasyShipApiCreateScheduledPackageRequest, options?: any): Promise>; /** * This operation automatically schedules a time slot for all specified `amazonOrderId` values and generates the associated shipping labels and compliance documents based on the marketplace. For more information, refer to the [marketplace support table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). You can optionally assign a `packageDetails` object to input a preferred time slot for each order in your request. In such cases, Amazon schedules the respective packages using the specified optional settings. If you don\'t specify a time slot, Amazon assigns the earliest available time slot. You can choose PDF or ZPL for your shipping label\'s file format and Amazon creates the label accordingly. This operation returns an array that contains the scheduled packages, and a temporary URL that you can use to access a ZIP file. The ZIP file includes the generated shipping labels and any other documents that are required for your marketplace. If an order can\'t be scheduled, Amazon adds the `rejectedOrders` list in the response. The response contains an entry for each order that could not be processed. Each entry contains an error message that describes the reason for the failure. The following table contains the supported request and burst maximum rates: **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {EasyShipApiCreateScheduledPackageBulkRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EasyShipApi */ createScheduledPackageBulk(requestParameters: EasyShipApiCreateScheduledPackageBulkRequest, options?: any): Promise>; /** * Returns information about a package, including dimensions, weight, time slot information for handover, invoice and item information, and status. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {EasyShipApiGetScheduledPackageRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EasyShipApi */ getScheduledPackage(requestParameters: EasyShipApiGetScheduledPackageRequest, options?: any): Promise>; /** * Returns time slots available for Easy Ship orders to be scheduled based on the package weight and dimensions that the seller specifies. This operation is available for scheduled and unscheduled orders based on marketplace support. See **Get Time Slots** in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). This operation can return time slots that have either pickup or drop-off handover methods - see **Supported Handover Methods** in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {EasyShipApiListHandoverSlotsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EasyShipApi */ listHandoverSlots(requestParameters?: EasyShipApiListHandoverSlotsRequest, options?: any): Promise>; /** * Updates the time slot for handing over the package indicated by the specified `scheduledPackageId`. You can get the new `slotId` value for the time slot by calling the `listHandoverSlots` operation before making another `patch` call. See the **Update Package** column in the [Marketplace Support Table](doc:easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) to see which marketplaces this operation is supported in. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api). * @param {EasyShipApiUpdateScheduledPackagesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EasyShipApi */ updateScheduledPackages(requestParameters?: EasyShipApiUpdateScheduledPackagesRequest, options?: any): Promise>; }