Function getBrands

  • Lists all brand entries for a tenant.

    Parameters

    • query: {
          endingBefore?: string;
          limit?: number;
          sort?:
              | "id"
              | "+createdAt"
              | "-createdAt"
              | "+updatedAt"
              | "-updatedAt"
              | "createdAt"
              | "updatedAt"
              | "+id"
              | "-id";
          startingAfter?: string;
      }

      an object with query parameters

      • OptionalendingBefore?: string

        Cursor to previous.

      • Optionallimit?: number

        Maximum number of brands to retrieve.

      • Optionalsort?:
            | "id"
            | "+createdAt"
            | "-createdAt"
            | "+updatedAt"
            | "-updatedAt"
            | "createdAt"
            | "updatedAt"
            | "+id"
            | "-id"

        Field to sort by, prefixed with -/+ to indicate the order.

      • OptionalstartingAfter?: string

        Cursor to the next page.

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetBrandsHttpResponse>

    GetBrandsHttpError