Class ShippingApi

ShippingApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- ShippingApi
  - ShippingApiClient

Index

Constructors

constructor

new ShippingApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): ShippingApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ShippingApi
Inherited from BaseAPI.constructor
- Defined in api-model/base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

cancelShipment

cancelShipment(
requestParameters: ShippingApiCancelShipmentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CancelShipmentResponse, any, {}, any>>
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.
Parameters
- requestParameters: ShippingApiCancelShipmentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CancelShipmentResponse, any, {}, any>>

Throws
- Defined in api-model/api/shipping-api.ts:683

createShipment

createShipment(
requestParameters: ShippingApiCreateShipmentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CreateShipmentResponse, any, {}, any>>
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.
Parameters
- requestParameters: ShippingApiCreateShipmentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateShipmentResponse, any, {}, any>>

Throws
- Defined in api-model/api/shipping-api.ts:693

getAccount

getAccount(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetAccountResponse, any, {}, any>>
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.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetAccountResponse, any, {}, any>>

Throws
- Defined in api-model/api/shipping-api.ts:702

getRates

getRates(
requestParameters: ShippingApiGetRatesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetRatesResponse, any, {}, any>>
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.
Parameters
- requestParameters: ShippingApiGetRatesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetRatesResponse, any, {}, any>>

Throws
- Defined in api-model/api/shipping-api.ts:712

getShipment

getShipment(
requestParameters: ShippingApiGetShipmentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetShipmentResponse, any, {}, any>>
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.
Parameters
- requestParameters: ShippingApiGetShipmentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetShipmentResponse, any, {}, any>>

Throws
- Defined in api-model/api/shipping-api.ts:722

getTrackingInformation

getTrackingInformation(
requestParameters: ShippingApiGetTrackingInformationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetTrackingInformationResponse, any, {}, any>>
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.
Parameters
- requestParameters: ShippingApiGetTrackingInformationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetTrackingInformationResponse, any, {}, any>>

Throws
- Defined in api-model/api/shipping-api.ts:732

purchaseLabels

purchaseLabels(
requestParameters: ShippingApiPurchaseLabelsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PurchaseLabelsResponse, any, {}, any>>
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.
Parameters
- requestParameters: ShippingApiPurchaseLabelsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PurchaseLabelsResponse, any, {}, any>>

Throws
- Defined in api-model/api/shipping-api.ts:742

purchaseShipment

purchaseShipment(
requestParameters: ShippingApiPurchaseShipmentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PurchaseShipmentResponse, any, {}, any>>
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.
Parameters
- requestParameters: ShippingApiPurchaseShipmentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PurchaseShipmentResponse, any, {}, any>>

Throws
- Defined in api-model/api/shipping-api.ts:752

retrieveShippingLabel

retrieveShippingLabel(
requestParameters: ShippingApiRetrieveShippingLabelRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RetrieveShippingLabelResponse, any, {}, any>>
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.
Parameters
- requestParameters: ShippingApiRetrieveShippingLabelRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RetrieveShippingLabelResponse, any, {}, any>>

Throws
- Defined in api-model/api/shipping-api.ts:762

Class ShippingApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ShippingApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

cancelShipment

Parameters

Returns Promise<AxiosResponse<CancelShipmentResponse, any, {}, any>>

Throws

createShipment

Parameters

Returns Promise<AxiosResponse<CreateShipmentResponse, any, {}, any>>

Throws

getAccount

Parameters

Returns Promise<AxiosResponse<GetAccountResponse, any, {}, any>>

Throws

getRates

Parameters

Returns Promise<AxiosResponse<GetRatesResponse, any, {}, any>>

Throws

getShipment

Parameters

Returns Promise<AxiosResponse<GetShipmentResponse, any, {}, any>>

Throws

getTrackingInformation

Parameters

Returns Promise<AxiosResponse<GetTrackingInformationResponse, any, {}, any>>

Throws

purchaseLabels

Parameters

Returns Promise<AxiosResponse<PurchaseLabelsResponse, any, {}, any>>

Throws

purchaseShipment

Parameters

Returns Promise<AxiosResponse<PurchaseShipmentResponse, any, {}, any>>

Throws

retrieveShippingLabel

Parameters

Returns Promise<AxiosResponse<RetrieveShippingLabelResponse, any, {}, any>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration