---
title: "GET /v1/vendor/catalog"
method: GET
path: "/v1/vendor/catalog"
tags: ["api.catalog.v1.VendorCatalogAPI"]
---

# GET /v1/vendor/catalog

`GET /v1/vendor/catalog`

## Query parameters

- `teamId` string
- `filter` ApiCatalogV1VendorCatalogFilter
  - `productIds` string[]
  - `searchText` string — @gotags: form:"search_text,omitempty"
- `paging` CommonTypeV1Paging
  - `page` integer — @gotags: form:"page"
  - `limit` integer — @gotags: form:"limit"
- `isLegacy` boolean

## Response `200`

- ApiCatalogV1VendorListCatalogResponse
  - `paging` CommonTypeV1PagingResponse
    - `total` union — @gotags: mapstructure:"total"
      - string
      - number
    - `totalPage` integer — @gotags: mapstructure:"total_page"
    - `page` integer — @gotags: mapstructure:"page"
    - `limit` integer — @gotags: mapstructure:"limit"
  - `data` ApiCatalogV1VendorCatalog[]
    - `productId` string — @gotags: mapstructure:"product_id"
    - `productName` string — @gotags: mapstructure:"product_name"
    - `productAvatarUrl` string — @gotags: mapstructure:"product_avatar_url"
    - `printLocations` ApiCatalogV1VendorCatalogPrintLocation[]
      - `code` string — @gotags: mapstructure:"code"
      - `name` string — @gotags: mapstructure:"name"
      - `locationId` integer — @gotags: mapstructure:"location_id"
    - `variants` ApiCatalogV1VendorCatalogVariant[]
      - `variantId` string — @gotags: mapstructure:"variant_id"
      - `name` string — @gotags: mapstructure:"name"
      - `size` string — @gotags: mapstructure:"size"
      - `color` string — @gotags: mapstructure:"color"
      - `hexColorCode` string — @gotags: mapstructure:"hex_color_code"
      - `price` CommonTypeV1Money — Represents an amount of money with its currency type.
        - `currencyCode` string — The three-letter currency code defined in ISO 4217. @gotags: mapstructure:"currency_code"
        - `units` union — The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @gotags: mapstructure:"units"
          - string
          - number
        - `nanos` integer — Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @gotags: mapstructure:"nanos"
      - `recommendedPrice` CommonTypeV1Money — Represents an amount of money with its currency type.
        - `currencyCode` string — The three-letter currency code defined in ISO 4217. @gotags: mapstructure:"currency_code"
        - `units` union — The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @gotags: mapstructure:"units"
          - string
          - number
        - `nanos` integer — Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @gotags: mapstructure:"nanos"
      - `extraPrice` CommonTypeV1Money — Represents an amount of money with its currency type.
        - `currencyCode` string — The three-letter currency code defined in ISO 4217. @gotags: mapstructure:"currency_code"
        - `units` union — The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @gotags: mapstructure:"units"
          - string
          - number
        - `nanos` integer — Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @gotags: mapstructure:"nanos"
      - `stockLabel` 'VENDOR_CATALOG_VARIANT_STOCK_LABEL_UNKNOWN' | 'VENDOR_CATALOG_VARIANT_STOCK_LABEL_IN_STOCK' | 'VENDOR_CATALOG_VARIANT_STOCK_LABEL_OUT_OF_STOCK' | 'VENDOR_CATALOG_VARIANT_STOCK_LABEL_OUT_OF_STOCK_5D' | 'VENDOR_CATALOG_VARIANT_STOCK_LABEL_DISCONTINUED' | 'VENDOR_CATALOG_VARIANT_STOCK_LABEL_ALL'
      - `product` ApiCatalogV1VendorCatalog — recursive

## Other responses

- `default`

---

[API](https://skmtc.dev/gearment/apis/api-webhook-v1.md) · [All operations](https://skmtc.dev/gearment/apis/api-webhook-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gearment/api-webhook-v1/revisions/a2e58da78818/schema)