Function VendorShippingApiFp

VendorShippingApi - functional programming interface

Export

  • VendorShippingApiFp(
        configuration?: Configuration,
    ): {
        createContainerLabel(
            body: CreateContainerLabelRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateContainerLabelResponse>,
        >;
        createShippingLabels(
            purchaseOrderNumber: string,
            body: CreateShippingLabelsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabel>,
        >;
        getCustomerInvoice(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CustomerInvoice>,
        >;
        getCustomerInvoices(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetCustomerInvoicesSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CustomerInvoiceList>,
        >;
        getPackingSlip(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackingSlip>,
        >;
        getPackingSlips(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetPackingSlipsSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PackingSlipList>,
        >;
        getShippingLabel(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabel>,
        >;
        getShippingLabels(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetShippingLabelsSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabelList>,
        >;
        submitShipmentConfirmations(
            body: SubmitShipmentConfirmationsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >;
        submitShipmentStatusUpdates(
            body: SubmitShipmentStatusUpdatesRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >;
        submitShippingLabelRequest(
            body: SubmitShippingLabelsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >;
    }

    Parameters

    • Optionalconfiguration: Configuration

    Returns {
        createContainerLabel(
            body: CreateContainerLabelRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateContainerLabelResponse>,
        >;
        createShippingLabels(
            purchaseOrderNumber: string,
            body: CreateShippingLabelsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabel>,
        >;
        getCustomerInvoice(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CustomerInvoice>,
        >;
        getCustomerInvoices(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetCustomerInvoicesSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CustomerInvoiceList>,
        >;
        getPackingSlip(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackingSlip>,
        >;
        getPackingSlips(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetPackingSlipsSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PackingSlipList>,
        >;
        getShippingLabel(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabel>,
        >;
        getShippingLabels(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetShippingLabelsSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabelList>,
        >;
        submitShipmentConfirmations(
            body: SubmitShipmentConfirmationsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >;
        submitShipmentStatusUpdates(
            body: SubmitShipmentStatusUpdatesRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >;
        submitShippingLabelRequest(
            body: SubmitShippingLabelsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >;
    }

    • createContainerLabel:function
      • createContainerLabel(
            body: CreateContainerLabelRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateContainerLabelResponse>,
        >

        Creates a container (pallet) label for the associated shipment package. 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 preceding table contains 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 Selling Partner API.

        Parameters

        • body: CreateContainerLabelRequest

          Request body containing the container label data.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateContainerLabelResponse>,
        >

        Throws

    • createShippingLabels:function
      • createShippingLabels(
            purchaseOrderNumber: string,
            body: CreateShippingLabelsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabel>,
        >

        Creates shipping labels for a purchase order and returns the labels. 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 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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • purchaseOrderNumber: string

          The purchase order number for which you want to return the shipping labels. It should be the same number as the `purchaseOrderNumber` in the order.

        • body: CreateShippingLabelsRequest

          The request payload that contains the parameters for creating shipping labels.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabel>,
        >

        Throws

    • getCustomerInvoice:function
      • getCustomerInvoice(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CustomerInvoice>,
        >

        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 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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • purchaseOrderNumber: string

          Purchase order number of the shipment for which to return the invoice.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CustomerInvoice>,
        >

        Throws

    • getCustomerInvoices:function
      • getCustomerInvoices(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetCustomerInvoicesSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CustomerInvoiceList>,
        >

        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 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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • createdAfter: string

          Orders that became available after this date and time will be included in the result. Values are in ISO 8601 date-time format.

        • createdBefore: string

          Orders that became available before this date and time will be included in the result. Values are in ISO 8601 date-time format.

        • OptionalshipFromPartyId: string

          The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.

        • Optionallimit: number

          The limit to the number of records returned

        • OptionalsortOrder: GetCustomerInvoicesSortOrderEnum

          Sort ASC or DESC by order creation date.

        • OptionalnextToken: string

          Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CustomerInvoiceList>,
        >

        Throws

    • getPackingSlip:function
      • getPackingSlip(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackingSlip>,
        >

        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 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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • purchaseOrderNumber: string

          The `purchaseOrderNumber` for the packing slip that you want.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackingSlip>>

        Throws

    • getPackingSlips:function
      • getPackingSlips(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetPackingSlipsSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PackingSlipList>,
        >

        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 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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • createdAfter: string

          Packing slips that become available after this date and time will be included in the result. Values are in ISO 8601 date-time format.

        • createdBefore: string

          Packing slips that became available before this date and time will be included in the result. Values are in ISO 8601 date-time format.

        • OptionalshipFromPartyId: string

          The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses.

        • Optionallimit: number

          The maximum number of records to return.

        • OptionalsortOrder: GetPackingSlipsSortOrderEnum

          The packing slip creation dates, which are sorted by ascending or descending order.

        • OptionalnextToken: string

          Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PackingSlipList>,
        >

        Throws

    • getShippingLabel:function
      • getShippingLabel(
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabel>,
        >

        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 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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • purchaseOrderNumber: string

          The purchase order number for which you want to return the shipping label. It should be the same `purchaseOrderNumber` that you received in the order.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabel>,
        >

        Throws

    • getShippingLabels:function
      • getShippingLabels(
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            limit?: number,
            sortOrder?: GetShippingLabelsSortOrderEnum,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabelList>,
        >

        Returns a list of shipping labels created during the time frame that you specify. Use the createdAfter and createdBefore parameters to define the time frame. You must use both of these parameters. The date range to search must not be more than seven 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 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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • createdAfter: string

          Shipping labels that became available after this date and time will be included in the result. Values are in ISO 8601 date-time format.

        • createdBefore: string

          Shipping labels that became available before this date and time will be included in the result. Values are in ISO 8601 date-time format.

        • OptionalshipFromPartyId: string

          The vendor `warehouseId` for order fulfillment. If not specified, the result contains orders for all warehouses.

        • Optionallimit: number

          The limit to the number of records returned.

        • OptionalsortOrder: GetShippingLabelsSortOrderEnum

          The sort order creation date. You can choose between ascending (`ASC`) or descending (`DESC`) sort order.

        • OptionalnextToken: string

          Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShippingLabelList>,
        >

        Throws

    • submitShipmentConfirmations:function
      • submitShipmentConfirmations(
            body: SubmitShipmentConfirmationsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >

        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 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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >

        Throws

    • submitShipmentStatusUpdates:function
      • submitShipmentStatusUpdates(
            body: SubmitShipmentStatusUpdatesRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >

        This operation is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API submits 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 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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >

        Throws

    • submitShippingLabelRequest:function
      • submitShippingLabelRequest(
            body: SubmitShippingLabelsRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >

        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 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 then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • body: SubmitShippingLabelsRequest

          The request body that contains the shipping labels data.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<TransactionReference>,
        >

        Throws

Settings

Member Visibility
MMNEPVFCICPMFPCPTTAAATR