---
title: "Get custom column list"
method: GET
path: "/v2/user/catalogs/{storeId}/customColumns"
tags: ["Catalogs - Catalog"]
---

# Get custom column list

`GET /v2/user/catalogs/{storeId}/customColumns`

## Path parameters

- `storeId` string, guid, required

## Response `200`

Custom column list

- CustomColumnList
  - `links` CustomColumnListLinks, required
    - `self` LinksCatalogGetCustomColumnsLink, required
      - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
      - `docUrl` string, uri — The documentation related to this operation.
      - `description` string — The description of the link
      - `href` string, required — Indicate the relative uri for this link
      - `operationId` string — The operationId to call.
      - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
      - `parameters` object
      - `urlTemplated` boolean — indicates whether the href is templated or not
      - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
      - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
      - `info` BeezUPCommonInfoSummaries
        - `successes` BeezUPCommonSuccessSummary[]
          - `successCode` string
          - `successMessage` string
          - `successArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
        - `errors` BeezUPCommonErrorSummary[]
          - `utcDate` string, date-time
          - `errorGuid` string, uuid
          - `errorCode` string
          - `errorMessage` string
          - `technicalErrorMessage` string
          - `exceptionDetail` BeezUPCommonExceptionDetail
            - `helpLink` string
            - `message` string
            - `stackTrace` string
            - `type` string
          - `errorArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
          - `source` string
        - `warnings` BeezUPCommonWarningSummary[]
          - `technicalErrorMessage` string
          - `warningMessage` string
          - `warningCode` string
          - `warningArguments` object
        - `informations` BeezUPCommonInfoSummary[]
          - `informationCode` string
          - `informationMessage` string
          - `informationArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
    - `add` LinksCatalogSaveCustomColumnLink
      - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
      - `docUrl` string, uri — The documentation related to this operation.
      - `description` string — The description of the link
      - `href` string, required — Indicate the relative uri for this link
      - `operationId` string — The operationId to call.
      - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
      - `parameters` object
      - `urlTemplated` boolean — indicates whether the href is templated or not
      - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
      - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
      - `info` BeezUPCommonInfoSummaries
        - `successes` BeezUPCommonSuccessSummary[]
          - `successCode` string
          - `successMessage` string
          - `successArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
        - `errors` BeezUPCommonErrorSummary[]
          - `utcDate` string, date-time
          - `errorGuid` string, uuid
          - `errorCode` string
          - `errorMessage` string
          - `technicalErrorMessage` string
          - `exceptionDetail` BeezUPCommonExceptionDetail
            - `helpLink` string
            - `message` string
            - `stackTrace` string
            - `type` string
          - `errorArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
          - `source` string
        - `warnings` BeezUPCommonWarningSummary[]
          - `technicalErrorMessage` string
          - `warningMessage` string
          - `warningCode` string
          - `warningArguments` object
        - `informations` BeezUPCommonInfoSummary[]
          - `informationCode` string
          - `informationMessage` string
          - `informationArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
  - `customColumns` CustomColumn[], required
    - `id` string, guid, required — The catalog column identifier
    - `userColumName` string, required — Column named by the user
    - `configuration` ColumnConfiguration, required — Indicates the configuration applied on the column (catalog or custom) during the importation process.
      - `beezUPColumnName` string — The BeezUP column name
      - `columnImportance` 'Required' | 'Recommended' | 'Optional', required — Importance of the column
      - `columnDataType` 'String' | 'Url' | 'Text' | 'Decimal' | 'DateTime' | 'Int' | 'SpecialInt' | 'InStock' | 'Unknown' | 'ImageUrl', required — Data type of the column, will be used for parsing and for consolidation proces
      - `columnCultureName` string — If non null, culture used to parse the value to the storage type of this column\r\n will be used for parsing and for consolidation proces
      - `columnFormat` string — If non null, format used to parse the value to the storage type of this column\r\n will be used for parsing and for consolidation proces
      - `canBeTruncated` boolean — If the size of the value is greater than the limit we can truncate the value instead of failing...
      - `displayGroupName` string — Indicate the display group name where the column must be putted
    - `catalogColumnDependencies` CatalogColumnName[]
    - `links` CustomColumnLinks, required
      - `save` LinksCatalogSaveCustomColumnLink, required
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `delete` LinksCatalogDeleteCustomColumnLink, required
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `rename` LinksCatalogChangeCustomColumnUserNameLink, required
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `expression` LinksCatalogGetCustomColumnExpressionLink, required
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `saveExpression` LinksCatalogChangeCustomColumnExpressionLink, required
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string

## Other responses

- `404` — StoreId not found
- `default` — Occurs when something goes wrong

---

[API](https://skmtc.net/beezup/apis/beezup-merchant-api.md) · [All operations](https://skmtc.net/beezup/apis/beezup-merchant-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/beezup/beezup-merchant-api/versions/557b7feddf8a/schema)