Function VendorShippingApiFactory

Returns {
    getCustomerInvoice(
        requestParameters: VendorShippingApiGetCustomerInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetCustomerInvoiceResponse>;
    getCustomerInvoices(
        requestParameters: VendorShippingApiGetCustomerInvoicesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetCustomerInvoicesResponse>;
    getPackingSlip(
        requestParameters: VendorShippingApiGetPackingSlipRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetPackingSlipResponse>;
    getPackingSlips(
        requestParameters: VendorShippingApiGetPackingSlipsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetPackingSlipListResponse>;
    getShippingLabel(
        requestParameters: VendorShippingApiGetShippingLabelRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShippingLabelResponse>;
    getShippingLabels(
        requestParameters: VendorShippingApiGetShippingLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShippingLabelListResponse>;
    submitShipmentConfirmations(
        requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SubmitShipmentConfirmationsResponse>;
    submitShipmentStatusUpdates(
        requestParameters: VendorShippingApiSubmitShipmentStatusUpdatesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SubmitShipmentStatusUpdatesResponse>;
    submitShippingLabelRequest(
        requestParameters: VendorShippingApiSubmitShippingLabelRequestRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SubmitShippingLabelsResponse>;
}

• getCustomerInvoice:function

  • getCustomerInvoice(
        requestParameters: VendorShippingApiGetCustomerInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetCustomerInvoiceResponse>

  • Returns a customer invoice based on the purchaseOrderNumber 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: VendorShippingApiGetCustomerInvoiceRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetCustomerInvoiceResponse>

    Throws

• getCustomerInvoices:function

  • getCustomerInvoices(
        requestParameters: VendorShippingApiGetCustomerInvoicesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetCustomerInvoicesResponse>

  • Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. 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: VendorShippingApiGetCustomerInvoicesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetCustomerInvoicesResponse>

    Throws

• getPackingSlip:function

  • getPackingSlip(
        requestParameters: VendorShippingApiGetPackingSlipRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetPackingSlipResponse>

  • Returns a packing slip based on the purchaseOrderNumber 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: VendorShippingApiGetPackingSlipRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetPackingSlipResponse>

    Throws

• getPackingSlips:function

  • getPackingSlips(
        requestParameters: VendorShippingApiGetPackingSlipsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetPackingSlipListResponse>

  • Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. 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: VendorShippingApiGetPackingSlipsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetPackingSlipListResponse>

    Throws

• getShippingLabel:function

  • getShippingLabel(
        requestParameters: VendorShippingApiGetShippingLabelRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShippingLabelResponse>

  • Returns a shipping label for the purchaseOrderNumber 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: VendorShippingApiGetShippingLabelRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetShippingLabelResponse>

    Throws

• getShippingLabels:function

  • getShippingLabels(
        requestParameters: VendorShippingApiGetShippingLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetShippingLabelListResponse>

  • Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. 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: VendorShippingApiGetShippingLabelsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetShippingLabelListResponse>

    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

• submitShipmentStatusUpdates:function

  • submitShipmentStatusUpdates(
        requestParameters: VendorShippingApiSubmitShipmentStatusUpdatesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SubmitShipmentStatusUpdatesResponse>

  • This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. 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: VendorShippingApiSubmitShipmentStatusUpdatesRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SubmitShipmentStatusUpdatesResponse>

    Throws

• submitShippingLabelRequest:function

  • submitShippingLabelRequest(
        requestParameters: VendorShippingApiSubmitShippingLabelRequestRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SubmitShippingLabelsResponse>

  • Creates a shipping label for a purchase order and returns a transactionId for reference. 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: VendorShippingApiSubmitShippingLabelRequestRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SubmitShippingLabelsResponse>

    Throws