Function AwdApiFactory

AwdApi - factory interface

Export

  • AwdApiFactory(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): {
        getInboundShipment(
            requestParameters: AwdApiGetInboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InboundShipment>;
        listInboundShipments(
            requestParameters?: AwdApiListInboundShipmentsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ShipmentListing>;
        listInventory(
            requestParameters?: AwdApiListInventoryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InventoryListing>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        getInboundShipment(
            requestParameters: AwdApiGetInboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InboundShipment>;
        listInboundShipments(
            requestParameters?: AwdApiListInboundShipmentsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ShipmentListing>;
        listInventory(
            requestParameters?: AwdApiListInventoryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InventoryListing>;
    }

    • getInboundShipment:function
      • getInboundShipment(
            requestParameters: AwdApiGetInboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): 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

        Returns AxiosPromise<InboundShipment>

        Throws

    • listInboundShipments:function
      • listInboundShipments(
            requestParameters?: AwdApiListInboundShipmentsRequest,
            options?: RawAxiosRequestConfig,
        ): 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

        Returns AxiosPromise<ShipmentListing>

        Throws

    • listInventory:function
      • listInventory(
            requestParameters?: AwdApiListInventoryRequest,
            options?: RawAxiosRequestConfig,
        ): 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

        • requestParameters: AwdApiListInventoryRequest = {}

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<InventoryListing>

        Throws

Settings

Member Visibility