Function VendorShippingApiFactory

Returns {
    getShipmentDetails(
        requestParameters?: VendorShippingApiGetShipmentDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentDetailsResponse>;
    getShipmentLabels(
        requestParameters?: VendorShippingApiGetShipmentLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentLabels>;
    submitShipmentConfirmations(
        requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SubmitShipmentConfirmationsResponse>;
    submitShipments(
        requestParameters: VendorShippingApiSubmitShipmentsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SubmitShipmentConfirmationsResponse>;
}

• getShipmentDetails:function

  • getShipmentDetails(
        requestParameters?: VendorShippingApiGetShipmentDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentDetailsResponse>

    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: VendorShippingApiGetShipmentDetailsRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetShipmentDetailsResponse>

    Throws

• getShipmentLabels:function

  • getShipmentLabels(
        requestParameters?: VendorShippingApiGetShipmentLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentLabels>

    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: VendorShippingApiGetShipmentLabelsRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetShipmentLabels>

    Throws

• submitShipmentConfirmations:function

  • submitShipmentConfirmations(
        requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SubmitShipmentConfirmationsResponse>

    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: VendorShippingApiSubmitShipmentConfirmationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SubmitShipmentConfirmationsResponse>

    Throws

• submitShipments:function

  • submitShipments(
        requestParameters: VendorShippingApiSubmitShipmentsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SubmitShipmentConfirmationsResponse>

    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: VendorShippingApiSubmitShipmentsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SubmitShipmentConfirmationsResponse>

    Throws