/**
* Selling Partner API for Shipping
* Provides programmatic access to Amazon Shipping APIs. **Note:** If you are new to the Amazon Shipping API, refer to the latest version of Amazon Shipping API (v2) on the Amazon Shipping Developer Documentation site.
*
* The version of the OpenAPI document: v1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Configuration } from './configuration';
import { AxiosPromise, AxiosInstance } from 'axios';
import { RequestArgs, BaseAPI } from './base';
/**
* The specific rate purchased for the shipment, or null if unpurchased.
* @export
* @interface AcceptedRate
*/
export interface AcceptedRate {
/**
*
* @type {Currency}
* @memberof AcceptedRate
*/
totalCharge?: Currency;
/**
*
* @type {Weight}
* @memberof AcceptedRate
*/
billedWeight?: Weight;
/**
*
* @type {ServiceType}
* @memberof AcceptedRate
*/
serviceType?: ServiceType | 'Amazon Shipping Ground' | 'Amazon Shipping Standard' | 'Amazon Shipping Premium';
/**
*
* @type {ShippingPromiseSet}
* @memberof AcceptedRate
*/
promise?: ShippingPromiseSet;
}
/**
* The account related data.
* @export
* @interface Account
*/
export interface Account {
/**
* This is the Amazon Shipping account id generated during the Amazon Shipping onboarding process.
* @type {string}
* @memberof Account
*/
accountId: string;
}
/**
* The address.
* @export
* @interface Address
*/
export interface Address {
/**
* The name of the person, business or institution at that address.
* @type {string}
* @memberof Address
*/
name: string;
/**
* First line of that address.
* @type {string}
* @memberof Address
*/
addressLine1: string;
/**
* Additional address information, if required.
* @type {string}
* @memberof Address
*/
addressLine2?: string;
/**
* Additional address information, if required.
* @type {string}
* @memberof Address
*/
addressLine3?: string;
/**
* The state or region where the person, business or institution is located.
* @type {string}
* @memberof Address
*/
stateOrRegion: string;
/**
* The city where the person, business or institution is located.
* @type {string}
* @memberof Address
*/
city: string;
/**
* The two digit country code. In ISO 3166-1 alpha-2 format.
* @type {string}
* @memberof Address
*/
countryCode: string;
/**
* The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
* @type {string}
* @memberof Address
*/
postalCode: string;
/**
* The email address of the contact associated with the address.
* @type {string}
* @memberof Address
*/
email?: string;
/**
* The email cc addresses of the contact associated with the address.
* @type {Array}
* @memberof Address
*/
copyEmails?: Array;
/**
* The phone number of the person, business or institution located at that address.
* @type {string}
* @memberof Address
*/
phoneNumber?: string;
}
/**
* The response schema for the cancelShipment operation.
* @export
* @interface CancelShipmentResponse
*/
export interface CancelShipmentResponse {
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array}
* @memberof CancelShipmentResponse
*/
errors?: Array;
}
/**
* Container in the shipment.
* @export
* @interface Container
*/
export interface Container {
/**
* The type of physical container being used. (always \'PACKAGE\')
* @type {string}
* @memberof Container
*/
containerType?: ContainerContainerTypeEnum | 'PACKAGE';
/**
* An identifier for the container. This must be unique within all the containers in the same shipment.
* @type {string}
* @memberof Container
*/
containerReferenceId: string;
/**
*
* @type {Currency}
* @memberof Container
*/
value: Currency;
/**
*
* @type {Dimensions}
* @memberof Container
*/
dimensions: Dimensions;
/**
* A list of the items in the container.
* @type {Array}
* @memberof Container
*/
items: Array;
/**
*
* @type {Weight}
* @memberof Container
*/
weight: Weight;
}
/**
* @export
* @enum {string}
*/
export declare enum ContainerContainerTypeEnum {
Package = "PACKAGE"
}
/**
* Item in the container.
* @export
* @interface ContainerItem
*/
export interface ContainerItem {
/**
* The quantity of the items of this type in the container.
* @type {number}
* @memberof ContainerItem
*/
quantity: number;
/**
*
* @type {Currency}
* @memberof ContainerItem
*/
unitPrice: Currency;
/**
*
* @type {Weight}
* @memberof ContainerItem
*/
unitWeight: Weight;
/**
* A descriptive title of the item.
* @type {string}
* @memberof ContainerItem
*/
title: string;
}
/**
* Container specification for checking the service rate.
* @export
* @interface ContainerSpecification
*/
export interface ContainerSpecification {
/**
*
* @type {Dimensions}
* @memberof ContainerSpecification
*/
dimensions: Dimensions;
/**
*
* @type {Weight}
* @memberof ContainerSpecification
*/
weight: Weight;
}
/**
* The request schema for the createShipment operation.
* @export
* @interface CreateShipmentRequest
*/
export interface CreateShipmentRequest {
/**
* Client reference id.
* @type {string}
* @memberof CreateShipmentRequest
*/
clientReferenceId: string;
/**
*
* @type {Address}
* @memberof CreateShipmentRequest
*/
shipTo: Address;
/**
*
* @type {Address}
* @memberof CreateShipmentRequest
*/
shipFrom: Address;
/**
* A list of container.
* @type {Array}
* @memberof CreateShipmentRequest
*/
containers: Array;
}
/**
* The response schema for the createShipment operation.
* @export
* @interface CreateShipmentResponse
*/
export interface CreateShipmentResponse {
/**
*
* @type {CreateShipmentResult}
* @memberof CreateShipmentResponse
*/
payload?: CreateShipmentResult;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array}
* @memberof CreateShipmentResponse
*/
errors?: Array;
}
/**
* The payload schema for the createShipment operation.
* @export
* @interface CreateShipmentResult
*/
export interface CreateShipmentResult {
/**
* The unique shipment identifier.
* @type {string}
* @memberof CreateShipmentResult
*/
shipmentId: string;
/**
* A list of all the available rates that can be used to send the shipment.
* @type {Array}
* @memberof CreateShipmentResult
*/
eligibleRates: Array;
}
/**
* The total value of all items in the container.
* @export
* @interface Currency
*/
export interface Currency {
/**
* The amount of currency.
* @type {number}
* @memberof Currency
*/
value: number;
/**
* A 3-character currency code.
* @type {string}
* @memberof Currency
*/
unit: string;
}
/**
* A set of measurements for a three-dimensional object.
* @export
* @interface Dimensions
*/
export interface Dimensions {
/**
* The length of the container.
* @type {number}
* @memberof Dimensions
*/
length: number;
/**
* The width of the container.
* @type {number}
* @memberof Dimensions
*/
width: number;
/**
* The height of the container.
* @type {number}
* @memberof Dimensions
*/
height: number;
/**
* The unit of these measurements.
* @type {string}
* @memberof Dimensions
*/
unit: DimensionsUnitEnum | 'IN' | 'CM';
}
/**
* @export
* @enum {string}
*/
export declare enum DimensionsUnitEnum {
In = "IN",
Cm = "CM"
}
/**
* An event of a shipment
* @export
* @interface Event
*/
export interface Event {
/**
* The event code of a shipment, such as Departed, Received, and ReadyForReceive.
* @type {string}
* @memberof Event
*/
eventCode: string;
/**
* The date and time of an event for a shipment.
* @type {string}
* @memberof Event
*/
eventTime: string;
/**
*
* @type {Location}
* @memberof Event
*/
location?: Location;
}
/**
* The response schema for the getAccount operation.
* @export
* @interface GetAccountResponse
*/
export interface GetAccountResponse {
/**
*
* @type {Account}
* @memberof GetAccountResponse
*/
payload?: Account;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array}
* @memberof GetAccountResponse
*/
errors?: Array;
}
/**
* The payload schema for the getRates operation.
* @export
* @interface GetRatesRequest
*/
export interface GetRatesRequest {
/**
*
* @type {Address}
* @memberof GetRatesRequest
*/
shipTo: Address;
/**
*
* @type {Address}
* @memberof GetRatesRequest
*/
shipFrom: Address;
/**
* A list of service types that can be used to send the shipment.
* @type {Array}
* @memberof GetRatesRequest
*/
serviceTypes: Array<(ServiceType | 'Amazon Shipping Ground' | 'Amazon Shipping Standard' | 'Amazon Shipping Premium')>;
/**
* The start date and time. This defaults to the current date and time.
* @type {string}
* @memberof GetRatesRequest
*/
shipDate?: string;
/**
* A list of container specifications.
* @type {Array}
* @memberof GetRatesRequest
*/
containerSpecifications: Array;
}
/**
* The response schema for the getRates operation.
* @export
* @interface GetRatesResponse
*/
export interface GetRatesResponse {
/**
*
* @type {GetRatesResult}
* @memberof GetRatesResponse
*/
payload?: GetRatesResult;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array}
* @memberof GetRatesResponse
*/
errors?: Array;
}
/**
* The payload schema for the getRates operation.
* @export
* @interface GetRatesResult
*/
export interface GetRatesResult {
/**
* A list of service rates.
* @type {Array}
* @memberof GetRatesResult
*/
serviceRates: Array;
}
/**
* The response schema for the getShipment operation.
* @export
* @interface GetShipmentResponse
*/
export interface GetShipmentResponse {
/**
*
* @type {Shipment}
* @memberof GetShipmentResponse
*/
payload?: Shipment;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array}
* @memberof GetShipmentResponse
*/
errors?: Array;
}
/**
* The response schema for the getTrackingInformation operation.
* @export
* @interface GetTrackingInformationResponse
*/
export interface GetTrackingInformationResponse {
/**
*
* @type {TrackingInformation}
* @memberof GetTrackingInformationResponse
*/
payload?: TrackingInformation;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array}
* @memberof GetTrackingInformationResponse
*/
errors?: Array;
}
/**
* The label details of the container.
* @export
* @interface Label
*/
export interface Label {
/**
* Contains binary image data encoded as a base-64 string.
* @type {string}
* @memberof Label
*/
labelStream?: string;
/**
*
* @type {LabelSpecification}
* @memberof Label
*/
labelSpecification?: LabelSpecification;
}
/**
* Label details including label stream, format, size.
* @export
* @interface LabelResult
*/
export interface LabelResult {
/**
* An identifier for the container. This must be unique within all the containers in the same shipment.
* @type {string}
* @memberof LabelResult
*/
containerReferenceId?: string;
/**
* The tracking identifier assigned to the container.
* @type {string}
* @memberof LabelResult
*/
trackingId?: string;
/**
*
* @type {Label}
* @memberof LabelResult
*/
label?: Label;
}
/**
* The label specification info.
* @export
* @interface LabelSpecification
*/
export interface LabelSpecification {
/**
* The format of the label. Enum of PNG only for now.
* @type {string}
* @memberof LabelSpecification
*/
labelFormat: LabelSpecificationLabelFormatEnum | 'PNG';
/**
* The label stock size specification in length and height. Enum of 4x6 only for now.
* @type {string}
* @memberof LabelSpecification
*/
labelStockSize: LabelSpecificationLabelStockSizeEnum | '4x6';
}
/**
* @export
* @enum {string}
*/
export declare enum LabelSpecificationLabelFormatEnum {
Png = "PNG"
}
/**
* @export
* @enum {string}
*/
export declare enum LabelSpecificationLabelStockSizeEnum {
_4x6 = "4x6"
}
/**
* The location where the person, business or institution is located.
* @export
* @interface Location
*/
export interface Location {
/**
* The state or region where the person, business or institution is located.
* @type {string}
* @memberof Location
*/
stateOrRegion?: string;
/**
* The city where the person, business or institution is located.
* @type {string}
* @memberof Location
*/
city?: string;
/**
* The two digit country code. In ISO 3166-1 alpha-2 format.
* @type {string}
* @memberof Location
*/
countryCode?: string;
/**
* The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
* @type {string}
* @memberof Location
*/
postalCode?: string;
}
/**
* Error response returned when the request is unsuccessful.
* @export
* @interface ModelError
*/
export interface ModelError {
/**
* An error code that identifies the type of error that occured.
* @type {string}
* @memberof ModelError
*/
code: string;
/**
* A message that describes the error condition in a human-readable form.
* @type {string}
* @memberof ModelError
*/
message: string;
/**
* Additional details that can help the caller understand or fix the issue.
* @type {string}
* @memberof ModelError
*/
details?: string;
}
/**
* The account related with the shipment.
* @export
* @interface Party
*/
export interface Party {
/**
* This is the Amazon Shipping account id generated during the Amazon Shipping onboarding process.
* @type {string}
* @memberof Party
*/
accountId?: string;
}
/**
* The request schema for the purchaseLabels operation.
* @export
* @interface PurchaseLabelsRequest
*/
export interface PurchaseLabelsRequest {
/**
* An identifier for the rating.
* @type {string}
* @memberof PurchaseLabelsRequest
*/
rateId: string;
/**
*
* @type {LabelSpecification}
* @memberof PurchaseLabelsRequest
*/
labelSpecification: LabelSpecification;
}
/**
* The response schema for the purchaseLabels operation.
* @export
* @interface PurchaseLabelsResponse
*/
export interface PurchaseLabelsResponse {
/**
*
* @type {PurchaseLabelsResult}
* @memberof PurchaseLabelsResponse
*/
payload?: PurchaseLabelsResult;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array}
* @memberof PurchaseLabelsResponse
*/
errors?: Array;
}
/**
* The payload schema for the purchaseLabels operation.
* @export
* @interface PurchaseLabelsResult
*/
export interface PurchaseLabelsResult {
/**
* The unique shipment identifier.
* @type {string}
* @memberof PurchaseLabelsResult
*/
shipmentId: string;
/**
* Client reference id.
* @type {string}
* @memberof PurchaseLabelsResult
*/
clientReferenceId?: string;
/**
*
* @type {AcceptedRate}
* @memberof PurchaseLabelsResult
*/
acceptedRate: AcceptedRate;
/**
* A list of label results
* @type {Array}
* @memberof PurchaseLabelsResult
*/
labelResults: Array;
}
/**
* The payload schema for the purchaseShipment operation.
* @export
* @interface PurchaseShipmentRequest
*/
export interface PurchaseShipmentRequest {
/**
* Client reference id.
* @type {string}
* @memberof PurchaseShipmentRequest
*/
clientReferenceId: string;
/**
*
* @type {Address}
* @memberof PurchaseShipmentRequest
*/
shipTo: Address;
/**
*
* @type {Address}
* @memberof PurchaseShipmentRequest
*/
shipFrom: Address;
/**
* The start date and time. This defaults to the current date and time.
* @type {string}
* @memberof PurchaseShipmentRequest
*/
shipDate?: string;
/**
*
* @type {ServiceType}
* @memberof PurchaseShipmentRequest
*/
serviceType: ServiceType | 'Amazon Shipping Ground' | 'Amazon Shipping Standard' | 'Amazon Shipping Premium';
/**
* A list of container.
* @type {Array}
* @memberof PurchaseShipmentRequest
*/
containers: Array;
/**
*
* @type {LabelSpecification}
* @memberof PurchaseShipmentRequest
*/
labelSpecification: LabelSpecification;
}
/**
* The response schema for the purchaseShipment operation.
* @export
* @interface PurchaseShipmentResponse
*/
export interface PurchaseShipmentResponse {
/**
*
* @type {PurchaseShipmentResult}
* @memberof PurchaseShipmentResponse
*/
payload?: PurchaseShipmentResult;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array}
* @memberof PurchaseShipmentResponse
*/
errors?: Array;
}
/**
* The payload schema for the purchaseShipment operation.
* @export
* @interface PurchaseShipmentResult
*/
export interface PurchaseShipmentResult {
/**
* The unique shipment identifier.
* @type {string}
* @memberof PurchaseShipmentResult
*/
shipmentId: string;
/**
*
* @type {ServiceRate}
* @memberof PurchaseShipmentResult
*/
serviceRate: ServiceRate;
/**
* A list of label results
* @type {Array}
* @memberof PurchaseShipmentResult
*/
labelResults: Array;
}
/**
* The available rate that can be used to send the shipment
* @export
* @interface Rate
*/
export interface Rate {
/**
* An identifier for the rate.
* @type {string}
* @memberof Rate
*/
rateId?: string;
/**
*
* @type {Currency}
* @memberof Rate
*/
totalCharge?: Currency;
/**
*
* @type {Weight}
* @memberof Rate
*/
billedWeight?: Weight;
/**
* The time after which the offering will expire.
* @type {string}
* @memberof Rate
*/
expirationTime?: string;
/**
*
* @type {ServiceType}
* @memberof Rate
*/
serviceType?: ServiceType | 'Amazon Shipping Ground' | 'Amazon Shipping Standard' | 'Amazon Shipping Premium';
/**
*
* @type {ShippingPromiseSet}
* @memberof Rate
*/
promise?: ShippingPromiseSet;
}
/**
* The request schema for the retrieveShippingLabel operation.
* @export
* @interface RetrieveShippingLabelRequest
*/
export interface RetrieveShippingLabelRequest {
/**
*
* @type {LabelSpecification}
* @memberof RetrieveShippingLabelRequest
*/
labelSpecification: LabelSpecification;
}
/**
* The response schema for the retrieveShippingLabel operation.
* @export
* @interface RetrieveShippingLabelResponse
*/
export interface RetrieveShippingLabelResponse {
/**
*
* @type {RetrieveShippingLabelResult}
* @memberof RetrieveShippingLabelResponse
*/
payload?: RetrieveShippingLabelResult;
/**
* A list of error responses returned when a request is unsuccessful.
* @type {Array}
* @memberof RetrieveShippingLabelResponse
*/
errors?: Array;
}
/**
* The payload schema for the retrieveShippingLabel operation.
* @export
* @interface RetrieveShippingLabelResult
*/
export interface RetrieveShippingLabelResult {
/**
* Contains binary image data encoded as a base-64 string.
* @type {string}
* @memberof RetrieveShippingLabelResult
*/
labelStream: string;
/**
*
* @type {LabelSpecification}
* @memberof RetrieveShippingLabelResult
*/
labelSpecification: LabelSpecification;
}
/**
* The specific rate for a shipping service, or null if no service available.
* @export
* @interface ServiceRate
*/
export interface ServiceRate {
/**
*
* @type {Currency}
* @memberof ServiceRate
*/
totalCharge: Currency;
/**
*
* @type {Weight}
* @memberof ServiceRate
*/
billableWeight: Weight;
/**
*
* @type {ServiceType}
* @memberof ServiceRate
*/
serviceType: ServiceType | 'Amazon Shipping Ground' | 'Amazon Shipping Standard' | 'Amazon Shipping Premium';
/**
*
* @type {ShippingPromiseSet}
* @memberof ServiceRate
*/
promise: ShippingPromiseSet;
}
/**
* The type of shipping service that will be used for the service offering.
* @export
* @enum {string}
*/
export declare enum ServiceType {
Ground = "Amazon Shipping Ground",
Standard = "Amazon Shipping Standard",
Premium = "Amazon Shipping Premium"
}
/**
* The shipment related data.
* @export
* @interface Shipment
*/
export interface Shipment {
/**
* The unique shipment identifier.
* @type {string}
* @memberof Shipment
*/
shipmentId: string;
/**
* Client reference id.
* @type {string}
* @memberof Shipment
*/
clientReferenceId: string;
/**
*
* @type {Address}
* @memberof Shipment
*/
shipFrom: Address;
/**
*
* @type {Address}
* @memberof Shipment
*/
shipTo: Address;
/**
*
* @type {AcceptedRate}
* @memberof Shipment
*/
acceptedRate?: AcceptedRate;
/**
*
* @type {Party}
* @memberof Shipment
*/
shipper?: Party;
/**
* A list of container.
* @type {Array}
* @memberof Shipment
*/
containers: Array;
}
/**
* The promised delivery time and pickup time.
* @export
* @interface ShippingPromiseSet
*/
export interface ShippingPromiseSet {
/**
*
* @type {TimeRange}
* @memberof ShippingPromiseSet
*/
deliveryWindow?: TimeRange;
/**
*
* @type {TimeRange}
* @memberof ShippingPromiseSet
*/
receiveWindow?: TimeRange;
}
/**
* The time range.
* @export
* @interface TimeRange
*/
export interface TimeRange {
/**
* The start date and time. This defaults to the current date and time.
* @type {string}
* @memberof TimeRange
*/
start?: string;
/**
* The end date and time. This must come after the value of start. This defaults to the next business day from the start.
* @type {string}
* @memberof TimeRange
*/
end?: string;
}
/**
* The payload schema for the getTrackingInformation operation.
* @export
* @interface TrackingInformation
*/
export interface TrackingInformation {
/**
* The tracking id generated to each shipment. It contains a series of letters or digits or both.
* @type {string}
* @memberof TrackingInformation
*/
trackingId: string;
/**
*
* @type {TrackingSummary}
* @memberof TrackingInformation
*/
summary: TrackingSummary;
/**
* The promised delivery date and time of a shipment.
* @type {string}
* @memberof TrackingInformation
*/
promisedDeliveryDate: string;
/**
* A list of events of a shipment.
* @type {Array}
* @memberof TrackingInformation
*/
eventHistory: Array;
}
/**
* The tracking summary.
* @export
* @interface TrackingSummary
*/
export interface TrackingSummary {
/**
* The derived status based on the events in the eventHistory.
* @type {string}
* @memberof TrackingSummary
*/
status?: string;
}
/**
* The weight.
* @export
* @interface Weight
*/
export interface Weight {
/**
* The unit of measurement.
* @type {string}
* @memberof Weight
*/
unit: WeightUnitEnum | 'g' | 'kg' | 'oz' | 'lb';
/**
* The measurement value.
* @type {number}
* @memberof Weight
*/
value: number;
}
/**
* @export
* @enum {string}
*/
export declare enum WeightUnitEnum {
G = "g",
Kg = "kg",
Oz = "oz",
Lb = "lb"
}
/**
* ShippingApi - axios parameter creator
* @export
*/
export declare const ShippingApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelShipment: (shipmentId: string, options?: any) => Promise;
/**
* Create a new shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 {CreateShipmentRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createShipment: (body: CreateShipmentRequest, options?: any) => Promise;
/**
* Verify if the current account is valid. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAccount: (options?: any) => Promise;
/**
* Get service rates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {GetRatesRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRates: (body: GetRatesRequest, options?: any) => Promise;
/**
* Return the entire shipment object for the shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getShipment: (shipmentId: string, options?: any) => Promise;
/**
* Return the tracking information of a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} trackingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrackingInformation: (trackingId: string, options?: any) => Promise;
/**
* Purchase shipping labels based on a given rate. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {PurchaseLabelsRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purchaseLabels: (shipmentId: string, body: PurchaseLabelsRequest, options?: any) => Promise;
/**
* Purchase shipping labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {PurchaseShipmentRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purchaseShipment: (body: PurchaseShipmentRequest, options?: any) => Promise;
/**
* Retrieve shipping label based on the shipment id and tracking id. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {string} trackingId
* @param {RetrieveShippingLabelRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveShippingLabel: (shipmentId: string, trackingId: string, body: RetrieveShippingLabelRequest, options?: any) => Promise;
};
/**
* ShippingApi - functional programming interface
* @export
*/
export declare const ShippingApiFp: (configuration?: Configuration) => {
/**
* Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelShipment(shipmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Create a new shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 {CreateShipmentRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createShipment(body: CreateShipmentRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Verify if the current account is valid. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAccount(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get service rates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {GetRatesRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRates(body: GetRatesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Return the entire shipment object for the shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getShipment(shipmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Return the tracking information of a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} trackingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrackingInformation(trackingId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Purchase shipping labels based on a given rate. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {PurchaseLabelsRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purchaseLabels(shipmentId: string, body: PurchaseLabelsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Purchase shipping labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {PurchaseShipmentRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purchaseShipment(body: PurchaseShipmentRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Retrieve shipping label based on the shipment id and tracking id. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {string} trackingId
* @param {RetrieveShippingLabelRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveShippingLabel(shipmentId: string, trackingId: string, body: RetrieveShippingLabelRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* ShippingApi - factory interface
* @export
*/
export declare const ShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelShipment(shipmentId: string, options?: any): AxiosPromise;
/**
* Create a new shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 {CreateShipmentRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createShipment(body: CreateShipmentRequest, options?: any): AxiosPromise;
/**
* Verify if the current account is valid. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAccount(options?: any): AxiosPromise;
/**
* Get service rates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {GetRatesRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRates(body: GetRatesRequest, options?: any): AxiosPromise;
/**
* Return the entire shipment object for the shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getShipment(shipmentId: string, options?: any): AxiosPromise;
/**
* Return the tracking information of a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} trackingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrackingInformation(trackingId: string, options?: any): AxiosPromise;
/**
* Purchase shipping labels based on a given rate. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {PurchaseLabelsRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purchaseLabels(shipmentId: string, body: PurchaseLabelsRequest, options?: any): AxiosPromise;
/**
* Purchase shipping labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {PurchaseShipmentRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
purchaseShipment(body: PurchaseShipmentRequest, options?: any): AxiosPromise;
/**
* Retrieve shipping label based on the shipment id and tracking id. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {string} shipmentId
* @param {string} trackingId
* @param {RetrieveShippingLabelRequest} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveShippingLabel(shipmentId: string, trackingId: string, body: RetrieveShippingLabelRequest, options?: any): AxiosPromise;
};
/**
* Request parameters for cancelShipment operation in ShippingApi.
* @export
* @interface ShippingApiCancelShipmentRequest
*/
export interface ShippingApiCancelShipmentRequest {
/**
*
* @type {string}
* @memberof ShippingApiCancelShipment
*/
readonly shipmentId: string;
}
/**
* Request parameters for createShipment operation in ShippingApi.
* @export
* @interface ShippingApiCreateShipmentRequest
*/
export interface ShippingApiCreateShipmentRequest {
/**
*
* @type {CreateShipmentRequest}
* @memberof ShippingApiCreateShipment
*/
readonly body: CreateShipmentRequest;
}
/**
* Request parameters for getRates operation in ShippingApi.
* @export
* @interface ShippingApiGetRatesRequest
*/
export interface ShippingApiGetRatesRequest {
/**
*
* @type {GetRatesRequest}
* @memberof ShippingApiGetRates
*/
readonly body: GetRatesRequest;
}
/**
* Request parameters for getShipment operation in ShippingApi.
* @export
* @interface ShippingApiGetShipmentRequest
*/
export interface ShippingApiGetShipmentRequest {
/**
*
* @type {string}
* @memberof ShippingApiGetShipment
*/
readonly shipmentId: string;
}
/**
* Request parameters for getTrackingInformation operation in ShippingApi.
* @export
* @interface ShippingApiGetTrackingInformationRequest
*/
export interface ShippingApiGetTrackingInformationRequest {
/**
*
* @type {string}
* @memberof ShippingApiGetTrackingInformation
*/
readonly trackingId: string;
}
/**
* Request parameters for purchaseLabels operation in ShippingApi.
* @export
* @interface ShippingApiPurchaseLabelsRequest
*/
export interface ShippingApiPurchaseLabelsRequest {
/**
*
* @type {string}
* @memberof ShippingApiPurchaseLabels
*/
readonly shipmentId: string;
/**
*
* @type {PurchaseLabelsRequest}
* @memberof ShippingApiPurchaseLabels
*/
readonly body: PurchaseLabelsRequest;
}
/**
* Request parameters for purchaseShipment operation in ShippingApi.
* @export
* @interface ShippingApiPurchaseShipmentRequest
*/
export interface ShippingApiPurchaseShipmentRequest {
/**
*
* @type {PurchaseShipmentRequest}
* @memberof ShippingApiPurchaseShipment
*/
readonly body: PurchaseShipmentRequest;
}
/**
* Request parameters for retrieveShippingLabel operation in ShippingApi.
* @export
* @interface ShippingApiRetrieveShippingLabelRequest
*/
export interface ShippingApiRetrieveShippingLabelRequest {
/**
*
* @type {string}
* @memberof ShippingApiRetrieveShippingLabel
*/
readonly shipmentId: string;
/**
*
* @type {string}
* @memberof ShippingApiRetrieveShippingLabel
*/
readonly trackingId: string;
/**
*
* @type {RetrieveShippingLabelRequest}
* @memberof ShippingApiRetrieveShippingLabel
*/
readonly body: RetrieveShippingLabelRequest;
}
/**
* ShippingApi - object-oriented interface
* @export
* @class ShippingApi
* @extends {BaseAPI}
*/
export declare class ShippingApi extends BaseAPI {
/**
* Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {ShippingApiCancelShipmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShippingApi
*/
cancelShipment(requestParameters: ShippingApiCancelShipmentRequest, options?: any): Promise>;
/**
* Create a new shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 {ShippingApiCreateShipmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShippingApi
*/
createShipment(requestParameters: ShippingApiCreateShipmentRequest, options?: any): Promise>;
/**
* Verify if the current account is valid. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShippingApi
*/
getAccount(options?: any): Promise>;
/**
* Get service rates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {ShippingApiGetRatesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShippingApi
*/
getRates(requestParameters: ShippingApiGetRatesRequest, options?: any): Promise>;
/**
* Return the entire shipment object for the shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {ShippingApiGetShipmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShippingApi
*/
getShipment(requestParameters: ShippingApiGetShipmentRequest, options?: any): Promise>;
/**
* Return the tracking information of a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {ShippingApiGetTrackingInformationRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShippingApi
*/
getTrackingInformation(requestParameters: ShippingApiGetTrackingInformationRequest, options?: any): Promise>;
/**
* Purchase shipping labels based on a given rate. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {ShippingApiPurchaseLabelsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShippingApi
*/
purchaseLabels(requestParameters: ShippingApiPurchaseLabelsRequest, options?: any): Promise>;
/**
* Purchase shipping labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {ShippingApiPurchaseShipmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShippingApi
*/
purchaseShipment(requestParameters: ShippingApiPurchaseShipmentRequest, options?: any): Promise>;
/**
* Retrieve shipping label based on the shipment id and tracking id. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
* @param {ShippingApiRetrieveShippingLabelRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShippingApi
*/
retrieveShippingLabel(requestParameters: ShippingApiRetrieveShippingLabelRequest, options?: any): Promise>;
}