Function MerchantFulfillmentApiFactory

Returns {
    cancelShipment(
        requestParameters: MerchantFulfillmentApiCancelShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelShipmentResponse>;
    createShipment(
        requestParameters: MerchantFulfillmentApiCreateShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateShipmentResponse>;
    getAdditionalSellerInputs(
        requestParameters: MerchantFulfillmentApiGetAdditionalSellerInputsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAdditionalSellerInputsResponse>;
    getEligibleShipmentServices(
        requestParameters: MerchantFulfillmentApiGetEligibleShipmentServicesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetEligibleShipmentServicesResponse>;
    getShipment(
        requestParameters: MerchantFulfillmentApiGetShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentResponse>;
}

• cancelShipment:function

  • cancelShipment(
        requestParameters: MerchantFulfillmentApiCancelShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelShipmentResponse>

    Cancel the shipment indicated by the specified shipment identifier. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

    Parameters

    • requestParameters: MerchantFulfillmentApiCancelShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CancelShipmentResponse>

    Throws

• createShipment:function

  • createShipment(
        requestParameters: MerchantFulfillmentApiCreateShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateShipmentResponse>

    Create a shipment with the information provided. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

    Parameters

    • requestParameters: MerchantFulfillmentApiCreateShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CreateShipmentResponse>

    Throws

• getAdditionalSellerInputs:function

  • getAdditionalSellerInputs(
        requestParameters: MerchantFulfillmentApiGetAdditionalSellerInputsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAdditionalSellerInputsResponse>

    Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

    Parameters

    • requestParameters: MerchantFulfillmentApiGetAdditionalSellerInputsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetAdditionalSellerInputsResponse>

    Throws

• getEligibleShipmentServices:function

  • getEligibleShipmentServices(
        requestParameters: MerchantFulfillmentApiGetEligibleShipmentServicesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetEligibleShipmentServicesResponse>

    Returns a list of shipping service offers that satisfy the specified shipment request details. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 6 | 12 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

    Parameters

    • requestParameters: MerchantFulfillmentApiGetEligibleShipmentServicesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetEligibleShipmentServicesResponse>

    Throws

• getShipment:function

  • getShipment(
        requestParameters: MerchantFulfillmentApiGetShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShipmentResponse>

    Returns the shipment information for an existing shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.

    Parameters

    • requestParameters: MerchantFulfillmentApiGetShipmentRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetShipmentResponse>

    Throws