Function VendorShipmentsApiFp

Returns {
    getShipmentDetails(
        limit?: number,
        sortOrder?: GetShipmentDetailsSortOrderEnum,
        nextToken?: string,
        createdAfter?: string,
        createdBefore?: string,
        shipmentConfirmedBefore?: string,
        shipmentConfirmedAfter?: string,
        packageLabelCreatedBefore?: string,
        packageLabelCreatedAfter?: string,
        shippedBefore?: string,
        shippedAfter?: string,
        estimatedDeliveryBefore?: string,
        estimatedDeliveryAfter?: string,
        shipmentDeliveryBefore?: string,
        shipmentDeliveryAfter?: string,
        requestedPickUpBefore?: string,
        requestedPickUpAfter?: string,
        scheduledPickUpBefore?: string,
        scheduledPickUpAfter?: string,
        currentShipmentStatus?: string,
        vendorShipmentIdentifier?: string,
        buyerReferenceNumber?: string,
        buyerWarehouseCode?: string,
        sellerWarehouseCode?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetShipmentDetailsResponse>,
    >;
    getShipmentLabels(
        limit?: number,
        sortOrder?: GetShipmentLabelsSortOrderEnum,
        nextToken?: string,
        labelCreatedAfter?: string,
        labelCreatedBefore?: string,
        buyerReferenceNumber?: string,
        vendorShipmentIdentifier?: string,
        sellerWarehouseCode?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetShipmentLabels>,
    >;
    submitShipmentConfirmation(
        body: SubmitShipmentConfirmationRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SubmitShipmentConfirmationResponse>,
    >;
    submitShipmentConfirmations(
        body: SubmitShipmentConfirmationsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SubmitShipmentConfirmationsResponse>,
    >;
    submitShipments(
        body: SubmitShipments,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SubmitShipmentConfirmationsResponse>,
    >;
}

• getShipmentDetails: function

  • getShipmentDetails(
        limit?: number,
        sortOrder?: GetShipmentDetailsSortOrderEnum,
        nextToken?: string,
        createdAfter?: string,
        createdBefore?: string,
        shipmentConfirmedBefore?: string,
        shipmentConfirmedAfter?: string,
        packageLabelCreatedBefore?: string,
        packageLabelCreatedAfter?: string,
        shippedBefore?: string,
        shippedAfter?: string,
        estimatedDeliveryBefore?: string,
        estimatedDeliveryAfter?: string,
        shipmentDeliveryBefore?: string,
        shipmentDeliveryAfter?: string,
        requestedPickUpBefore?: string,
        requestedPickUpAfter?: string,
        scheduledPickUpBefore?: string,
        scheduledPickUpAfter?: string,
        currentShipmentStatus?: string,
        vendorShipmentIdentifier?: string,
        buyerReferenceNumber?: string,
        buyerWarehouseCode?: string,
        sellerWarehouseCode?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • Optionallimit: number

      The limit to the number of records returned. Default value is 50 records.

    • OptionalsortOrder: GetShipmentDetailsSortOrderEnum

      Sort in ascending or descending order by purchase order creation date.

    • OptionalnextToken: string

      Used for pagination when there are more shipments than the specified result size limit.

    • OptionalcreatedAfter: string

      Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalcreatedBefore: string

      Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalshipmentConfirmedBefore: string

      Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalshipmentConfirmedAfter: string

      Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalpackageLabelCreatedBefore: string

      Get Shipment Details by passing Package label create Date by buyer. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalpackageLabelCreatedAfter: string

      Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalshippedBefore: string

      Get Shipment Details by passing Shipped Date Before. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalshippedAfter: string

      Get Shipment Details by passing Shipped Date After. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalestimatedDeliveryBefore: string

      Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalestimatedDeliveryAfter: string

      Get Shipment Details by passing Estimated Delivery Date After. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalshipmentDeliveryBefore: string

      Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalshipmentDeliveryAfter: string

      Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalrequestedPickUpBefore: string

      Get Shipment Details by passing Before Requested pickup date. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalrequestedPickUpAfter: string

      Get Shipment Details by passing After Requested pickup date. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalscheduledPickUpBefore: string

      Get Shipment Details by passing Before scheduled pickup date. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalscheduledPickUpAfter: string

      Get Shipment Details by passing After Scheduled pickup date. Must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.

    • OptionalcurrentShipmentStatus: string

      Get Shipment Details by passing Current shipment status.

    • OptionalvendorShipmentIdentifier: string

      Get Shipment Details by passing Vendor Shipment ID

    • OptionalbuyerReferenceNumber: string

      Get Shipment Details by passing buyer Reference ID

    • OptionalbuyerWarehouseCode: string

      Get Shipping Details based on buyer warehouse code. This value should be same as &#39;shipToParty.partyId&#39; in the Shipment.

    • OptionalsellerWarehouseCode: string

      Get Shipping Details based on vendor warehouse code. This value should be same as &#39;sellingParty.partyId&#39; in the Shipment.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getShipmentLabels: function

  • getShipmentLabels(
        limit?: number,
        sortOrder?: GetShipmentLabelsSortOrderEnum,
        nextToken?: string,
        labelCreatedAfter?: string,
        labelCreatedBefore?: string,
        buyerReferenceNumber?: string,
        vendorShipmentIdentifier?: string,
        sellerWarehouseCode?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • Optionallimit: number

      The limit to the number of records returned. Default value is 50 records.

    • OptionalsortOrder: GetShipmentLabelsSortOrderEnum

      Sort the list by shipment label creation date in ascending or descending order.

    • OptionalnextToken: string

      A token that you use to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.

    • OptionallabelCreatedAfter: string

      Shipment labels created after this time will be included in the result. This field must be in ISO 8601 datetime format.

    • OptionallabelCreatedBefore: string

      Shipment labels created before this time will be included in the result. This field must be in ISO 8601 datetime format.

    • OptionalbuyerReferenceNumber: string

      Get Shipment labels by passing buyer reference number.

    • OptionalvendorShipmentIdentifier: string

      Get Shipment labels by passing vendor shipment identifier.

    • OptionalsellerWarehouseCode: string

      Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• submitShipmentConfirmation: function

  • submitShipmentConfirmation(
        body: SubmitShipmentConfirmationRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SubmitShipmentConfirmationResponse>,
    >

    Submits one shipment confirmation for vendor orders and get response immediately. 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

    • body: SubmitShipmentConfirmationRequest

      A request to submit shipment confirmation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• submitShipmentConfirmations: function

  • submitShipmentConfirmations(
        body: SubmitShipmentConfirmationsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • body: SubmitShipmentConfirmationsRequest

      A request to submit shipment confirmation.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• submitShipments: function

  • submitShipments(
        body: SubmitShipments,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • body: SubmitShipments

      A request to submit shipment request.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws