ListingsApi - factory interface

  • Parameters

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

    Returns {
        deleteListingsItem(
            requestParameters: ListingsApiDeleteListingsItemRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ListingsItemSubmissionResponse>;
        getListingsItem(
            requestParameters: ListingsApiGetListingsItemRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Item>;
        patchListingsItem(
            requestParameters: ListingsApiPatchListingsItemRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ListingsItemSubmissionResponse>;
        putListingsItem(
            requestParameters: ListingsApiPutListingsItemRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ListingsItemSubmissionResponse>;
        searchListingsItems(
            requestParameters: ListingsApiSearchListingsItemsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ItemSearchResults>;
    }

    • deleteListingsItem:function
      • Delete a listings item for a selling partner. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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

        Returns AxiosPromise<ListingsItemSubmissionResponse>

    • getListingsItem:function
      • Returns details about a listings item for a selling partner. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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

        Returns AxiosPromise<Item>

    • patchListingsItem:function
      • Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | 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 can receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API documentation.

        Parameters

        Returns AxiosPromise<ListingsItemSubmissionResponse>

    • putListingsItem:function
      • Creates or fully updates an existing listings item for a selling partner. Note: This operation has a throttling rate of one request per second when mode is VALIDATION_PREVIEW. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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

        Returns AxiosPromise<ListingsItemSubmissionResponse>

    • searchListingsItems:function
      • Search for and return a list of selling partner listings items and their respective details. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested 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

        Returns AxiosPromise<ItemSearchResults>