Function AwdApiFactory

AwdApi - factory interface

Export

  • AwdApiFactory(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): {
        cancelInbound(
            requestParameters: AwdApiCancelInboundRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        checkInboundEligibility(
            requestParameters: AwdApiCheckInboundEligibilityRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InboundEligibility>;
        confirmInbound(
            requestParameters: AwdApiConfirmInboundRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        createInbound(
            requestParameters: AwdApiCreateInboundRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InboundOrderReference>;
        getInbound(
            requestParameters: AwdApiGetInboundRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InboundOrder>;
        getInboundShipment(
            requestParameters: AwdApiGetInboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InboundShipment>;
        getInboundShipmentLabels(
            requestParameters: AwdApiGetInboundShipmentLabelsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ShipmentLabels>;
        listInboundShipments(
            requestParameters?: AwdApiListInboundShipmentsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ShipmentListing>;
        listInventory(
            requestParameters?: AwdApiListInventoryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InventoryListing>;
        updateInbound(
            requestParameters: AwdApiUpdateInboundRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        updateInboundShipmentTransportDetails(
            requestParameters: AwdApiUpdateInboundShipmentTransportDetailsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
    }

    Parameters

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

    Returns {
        cancelInbound(
            requestParameters: AwdApiCancelInboundRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        checkInboundEligibility(
            requestParameters: AwdApiCheckInboundEligibilityRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InboundEligibility>;
        confirmInbound(
            requestParameters: AwdApiConfirmInboundRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        createInbound(
            requestParameters: AwdApiCreateInboundRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InboundOrderReference>;
        getInbound(
            requestParameters: AwdApiGetInboundRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InboundOrder>;
        getInboundShipment(
            requestParameters: AwdApiGetInboundShipmentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InboundShipment>;
        getInboundShipmentLabels(
            requestParameters: AwdApiGetInboundShipmentLabelsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ShipmentLabels>;
        listInboundShipments(
            requestParameters?: AwdApiListInboundShipmentsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ShipmentListing>;
        listInventory(
            requestParameters?: AwdApiListInventoryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<InventoryListing>;
        updateInbound(
            requestParameters: AwdApiUpdateInboundRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        updateInboundShipmentTransportDetails(
            requestParameters: AwdApiUpdateInboundShipmentTransportDetailsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
    }

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

        • requestParameters: AwdApiCancelInboundRequest

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

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

        Returns AxiosPromise<InboundEligibility>

        Throws

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

        Returns AxiosPromise<void>

        Throws

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

        • requestParameters: AwdApiCreateInboundRequest

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<InboundOrderReference>

        Throws

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

        • requestParameters: AwdApiGetInboundRequest

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<InboundOrder>

        Throws

    • 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

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

        Returns AxiosPromise<ShipmentLabels>

        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

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

        • requestParameters: AwdApiUpdateInboundRequest

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

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

        Returns AxiosPromise<void>

        Throws

Settings

Member Visibility
MMNEPVFCICPMFPCPTTAAATR