Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...
    • SupportApi - functional programming interface

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          getCase(
              caseId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Case>,
          >;
          listCases(
              body: ListCasesRequest,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ListCasesResult>,
          >;
          listContacts(
              caseId: string,
              maxResults?: number,
              nextToken?: string,
              sortOrder?: ListContactsSortOrderEnum,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ListContactsResult>,
          >;
      }

      • getCase: function
        • Retrieve a specific support case.

          Parameters

          • caseId: string

            The case identifier.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • listCases: function
        • Retrieve support cases for a selling partner.

          Parameters

          • body: ListCasesRequest

            The request body for the listCases operation.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • listContacts: function
        • Retrieve contacts for a specific support case.

          Parameters

          • caseId: string

            The case identifier.

          • OptionalmaxResults: number

            The maximum number of results to include in the response.

          • OptionalnextToken: string

            A token 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.

          • OptionalsortOrder: ListContactsSortOrderEnum

            Sort the returned contacts by `createdDate` in either ascending or descending order.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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