--- title: "Get the index of the catalog API for this store" method: GET path: "/v2/user/catalogs/{storeId}" tags: ["Catalogs - Catalog"] --- # Get the index of the catalog API for this store `GET /v2/user/catalogs/{storeId}` The operation will give you all the operations you will be able to do on this store for this API. ## Path parameters - `storeId` string, guid, required ## Response `200` The catalog index - CatalogStoreIndex - `links` CatalogStoreIndexLinks, required - `self` LinksCatalogStoreIndexLink, 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 - `inputConfiguration` LinksImportationGetManualUpdateLastInputConfigLink - `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 - `autoImportInfo` LinksAutoGetAutoImportConfigurationLink - `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 - `importations` LinksImportationGetReportingsLink - `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 - `startImportation` LinksImportationStartManualUpdateLink - `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 - `catalogColumns` LinksCatalogGetCatalogColumnsLink - `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` LinksCatalogGetCustomColumnsLink - `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 - `categories` LinksCatalogGetCategoriesLink - `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 - `products` LinksCatalogGetProductsLink - `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 - `randomProducts` LinksCatalogGetRandomProductsLink - `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 - `computeExpression` LinksCatalogComputeExpressionLink - `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 - `status` 'OK' | 'Failed' | 'Outdated', required — Indicates the status of the catalog store. * OK: If the latest importation is a success! * Failed: If the latest importation has failed ! * Outdated: If the latest succeed importation is later than 1 day. ## Other responses - `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)