Function AwdApiFp

Returns {
    cancelInbound(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    checkInboundEligibility(
        body: InboundPackages,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundEligibility>,
    >;
    confirmInbound(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    createInbound(
        body: InboundOrderCreationData,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundOrderReference>,
    >;
    getInbound(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundOrder>,
    >;
    getInboundShipment(
        shipmentId: string,
        skuQuantities?: GetInboundShipmentSkuQuantitiesEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundShipment>,
    >;
    getInboundShipmentLabels(
        shipmentId: string,
        pageType?: GetInboundShipmentLabelsPageTypeEnum,
        formatType?: "PDF",
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShipmentLabels>,
    >;
    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>,
    >;
    updateInbound(
        orderId: string,
        body: InboundOrder,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updateInboundShipmentTransportDetails(
        shipmentId: string,
        body: TransportationDetails,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• cancelInbound:function

  • cancelInbound(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Cancels an AWD Inbound order and its associated shipment. 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 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 Selling Partner API.

    Parameters

    • orderId: string

      The ID of the inbound order you want to cancel.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• checkInboundEligibility:function

  • checkInboundEligibility(
        body: InboundPackages,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundEligibility>,
    >

    Determines if the packages you specify are eligible for an AWD inbound order and contains error details for ineligible packages. 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 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 Selling Partner API.

    Parameters

    • body: InboundPackages

      Represents the packages you want to inbound.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• confirmInbound:function

  • confirmInbound(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Confirms an AWD inbound order in DRAFT status. 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

    • orderId: string

      The ID of the inbound order that you want to confirm.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createInbound:function

  • createInbound(
        body: InboundOrderCreationData,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InboundOrderReference>,
    >

    Creates a draft AWD inbound order with a list of packages for inbound shipment. The operation creates one shipment per order. 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 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 Selling Partner API.

    Parameters

    • body: InboundOrderCreationData

      Payload for creating an inbound order.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getInbound:function

  • getInbound(
        orderId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundOrder>,
    >

    Retrieves an AWD inbound order. 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 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 Selling Partner API.

    Parameters

    • orderId: string

      The ID of the inbound order that you want to retrieve.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• 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

• getInboundShipmentLabels:function

  • getInboundShipmentLabels(
        shipmentId: string,
        pageType?: GetInboundShipmentLabelsPageTypeEnum,
        formatType?: "PDF",
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShipmentLabels>,
    >

    Retrieves the box labels for a shipment ID that you specify. This is an asynchronous operation. If the label status is GENERATED, then the label URL is available. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | 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 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.
    • OptionalpageType: GetInboundShipmentLabelsPageTypeEnum

      Page type for the generated labels. The default is `PLAIN_PAPER`.
    • OptionalformatType: "PDF"

      The format type of the output file that contains your labels. The default format type is `PDF`.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    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

      A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` 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.
    • 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

      A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` 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.
    • OptionalmaxResults: number

      Maximum number of results to return.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updateInbound:function

  • updateInbound(
        orderId: string,
        body: InboundOrder,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Updates an AWD inbound order that is in DRAFT status and not yet confirmed. Use this operation to update the packagesToInbound, originAddress and preferences attributes. 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 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 Selling Partner API.

    Parameters

    • orderId: string

      The ID of the inbound order that you want to update.
    • body: InboundOrder

      Represents an AWD inbound order.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• updateInboundShipmentTransportDetails:function

  • updateInboundShipmentTransportDetails(
        shipmentId: string,
        body: TransportationDetails,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Updates transport details for an AWD shipment. 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

    • shipmentId: string

      The shipment ID.
    • body: TransportationDetails

      Transportation details for the shipment.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws