Class FulfillmentInboundApi

FulfillmentInboundApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- FulfillmentInboundApi
  - FulfillmentInboundApiClient

Index

Constructors

constructor

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

getBillOfLading

getBillOfLading(
requestParameters: FulfillmentInboundApiGetBillOfLadingRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetBillOfLadingResponse, any, {}>>
Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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: FulfillmentInboundApiGetBillOfLadingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetBillOfLadingResponse, any, {}>>
Throws
- Defined in api-model/api/fulfillment-inbound-api.ts:699

getLabels

getLabels(
requestParameters: FulfillmentInboundApiGetLabelsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetLabelsResponse, any, {}>>
Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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: FulfillmentInboundApiGetLabelsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetLabelsResponse, any, {}>>
Throws
- Defined in api-model/api/fulfillment-inbound-api.ts:709

getPrepInstructions

getPrepInstructions(
requestParameters: FulfillmentInboundApiGetPrepInstructionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetPrepInstructionsResponse, any, {}>>
Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon's fulfillment network. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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: FulfillmentInboundApiGetPrepInstructionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetPrepInstructionsResponse, any, {}>>
Throws
- Defined in api-model/api/fulfillment-inbound-api.ts:719

getShipmentItems

getShipmentItems(
requestParameters: FulfillmentInboundApiGetShipmentItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetShipmentItemsResponse, any, {}>>
Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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: FulfillmentInboundApiGetShipmentItemsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetShipmentItemsResponse, any, {}>>
Throws
- Defined in api-model/api/fulfillment-inbound-api.ts:729

getShipmentItemsByShipmentId

getShipmentItemsByShipmentId(
requestParameters: FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetShipmentItemsResponse, any, {}>>
Returns a list of items in a specified inbound shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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: FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetShipmentItemsResponse, any, {}>>
Throws
- Defined in api-model/api/fulfillment-inbound-api.ts:739

getShipments

getShipments(
requestParameters: FulfillmentInboundApiGetShipmentsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetShipmentsResponse, any, {}>>
Returns a list of inbound shipments based on criteria that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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: FulfillmentInboundApiGetShipmentsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetShipmentsResponse, any, {}>>
Throws
- Defined in api-model/api/fulfillment-inbound-api.ts:749

Class FulfillmentInboundApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FulfillmentInboundApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getBillOfLading

Parameters

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

Throws

getLabels

Parameters

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

Throws

getPrepInstructions

Parameters

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

Throws

getShipmentItems

Parameters

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

Throws

getShipmentItemsByShipmentId

Parameters

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

Throws

getShipments

Parameters

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

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration