Function AwdApiFp

Returns {
    getInboundShipment(
        shipmentId: string,
        skuQuantities?: GetInboundShipmentSkuQuantitiesEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundShipment>,
    >;
    listInboundShipments(
        sortBy?: ListInboundShipmentsSortByEnum,
        sortOrder?: ListInboundShipmentsSortOrderEnum,
        shipmentStatus?: ListInboundShipmentsShipmentStatusEnum,
        updatedAfter?: string,
        updatedBefore?: string,
        maxResults?: number,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShipmentListing>,
    >;
    listInventory(
        sku?: string,
        sortOrder?: ListInventorySortOrderEnum,
        details?: ListInventoryDetailsEnum,
        nextToken?: string,
        maxResults?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InventoryListing>,
    >;
}

• getInboundShipment:function

  • getInboundShipment(
        shipmentId: string,
        skuQuantities?: GetInboundShipmentSkuQuantitiesEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundShipment>,
    >

  • Retrieves an AWD inbound shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to Usage Plans and Rate Limits in the Selling Partner API

    Parameters

    • shipmentId: string

      ID for the shipment. A shipment contains the cases being inbounded.
    • OptionalskuQuantities: GetInboundShipmentSkuQuantitiesEnum

      If equal to `SHOW`, the response includes the shipment SKU quantity details. Defaults to `HIDE`, in which case the response does not contain SKU quantities
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• listInboundShipments:function

  • listInboundShipments(
        sortBy?: ListInboundShipmentsSortByEnum,
        sortOrder?: ListInboundShipmentsSortOrderEnum,
        shipmentStatus?: ListInboundShipmentsShipmentStatusEnum,
        updatedAfter?: string,
        updatedBefore?: string,
        maxResults?: number,
        nextToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShipmentListing>,
    >

  • Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | 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, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • OptionalsortBy: ListInboundShipmentsSortByEnum

      Field to sort results by. By default, the response will be sorted by UPDATED_AT.
    • OptionalsortOrder: ListInboundShipmentsSortOrderEnum

      Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.
    • OptionalshipmentStatus: ListInboundShipmentsShipmentStatusEnum

      Filter by inbound shipment status.
    • OptionalupdatedAfter: string

      List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.
    • OptionalupdatedBefore: string

      List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> format.
    • OptionalmaxResults: number

      Maximum number of results to return.
    • OptionalnextToken: string

      Token to retrieve the next set of paginated results.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• listInventory:function

  • listInventory(
        sku?: string,
        sortOrder?: ListInventorySortOrderEnum,
        details?: ListInventoryDetailsEnum,
        nextToken?: string,
        maxResults?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InventoryListing>,
    >

  • Lists AWD inventory associated with a merchant with the ability to apply optional filters. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • Optionalsku: string

      Filter by seller or merchant SKU for the item.
    • OptionalsortOrder: ListInventorySortOrderEnum

      Sort the response in `ASCENDING` or `DESCENDING` order.
    • Optionaldetails: ListInventoryDetailsEnum

      Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals.
    • OptionalnextToken: string

      Token to retrieve the next set of paginated results.
    • OptionalmaxResults: number

      Maximum number of results to return.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws