Class VendorShipmentsApi

VendorShipmentsApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- VendorShipmentsApi
  - VendorShipmentsApiClient

Index

Constructors

constructor

new VendorShipmentsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): VendorShipmentsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns VendorShipmentsApi
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

getShipmentDetails

getShipmentDetails(
requestParameters?: VendorShipmentsApiGetShipmentDetailsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetShipmentDetailsResponse, any, {}>>
Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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: VendorShipmentsApiGetShipmentDetailsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetShipmentDetailsResponse, any, {}>>
Throws
- Defined in api-model/api/vendor-shipments-api.ts:781

getShipmentLabels

getShipmentLabels(
requestParameters?: VendorShipmentsApiGetShipmentLabelsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetShipmentLabels, any, {}>>
Returns small parcel shipment labels based on the filters that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the 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.
Parameters
- requestParameters: VendorShipmentsApiGetShipmentLabelsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetShipmentLabels, any, {}>>
Throws
- Defined in api-model/api/vendor-shipments-api.ts:791

submitShipmentConfirmation

submitShipmentConfirmation(
requestParameters: VendorShipmentsApiSubmitShipmentConfirmationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SubmitShipmentConfirmationResponse, any, {}>>
Submits one shipment confirmation for vendor orders and get response immediately. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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: VendorShipmentsApiSubmitShipmentConfirmationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SubmitShipmentConfirmationResponse, any, {}>>
Throws
- Defined in api-model/api/vendor-shipments-api.ts:802

submitShipmentConfirmations

submitShipmentConfirmations(
requestParameters: VendorShipmentsApiSubmitShipmentConfirmationsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SubmitShipmentConfirmationsResponse, any, {}>>
Submits one or more shipment confirmations for vendor orders. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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: VendorShipmentsApiSubmitShipmentConfirmationsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SubmitShipmentConfirmationsResponse, any, {}>>
Throws
- Defined in api-model/api/vendor-shipments-api.ts:813

submitShipments

submitShipments(
requestParameters: VendorShipmentsApiSubmitShipmentsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SubmitShipmentConfirmationsResponse, any, {}>>
Submits one or more shipment request for vendor Orders. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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: VendorShipmentsApiSubmitShipmentsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SubmitShipmentConfirmationsResponse, any, {}>>
Throws
- Defined in api-model/api/vendor-shipments-api.ts:824

Class VendorShipmentsApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VendorShipmentsApi

Properties

`Protected`axios

`Protected`basePath

`Protected`configuration

Methods

getShipmentDetails

Parameters

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

Throws

getShipmentLabels

Parameters

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

Throws

submitShipmentConfirmation

Parameters

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

Throws

submitShipmentConfirmations

Parameters

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

Throws

submitShipments

Parameters

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

Throws

Settings

On This Page

Class VendorShipmentsApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VendorShipmentsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getShipmentDetails

Parameters

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

Throws

getShipmentLabels

Parameters

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

Throws

submitShipmentConfirmation

Parameters

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

Throws

submitShipmentConfirmations

Parameters

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

Throws

submitShipments

Parameters

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

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration