--- title: "Get the Analytics API operation index for one store" method: GET path: "/v2/user/analytics/{storeId}" tags: ["Analytics - Global"] --- # Get the Analytics API operation index for one store `GET /v2/user/analytics/{storeId}` ## Path parameters - `storeId` string, guid, required ## Response `200` Analytics API operation index for one store - AnalyticsStoreIndex - `links` AnalyticsStoreIndexLinks, required - `self` LinksAnalyticsIndexLink, 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 - `trackingStatus` LinksGetStoreTrackingStatusLink, 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 - `trackedClicks` LinksGetStoreTrackedClicksLink, 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 - `trackedOrders` LinksGetStoreTrackedOrdersLink, 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 - `trackedExternalOrders` LinksGetStoreTrackedExternalOrdersLink - `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 - `reportByDay` LinksGetStoreReportByDayLink - `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 - `reportByChannel` LinksGetStoreReportByChannelLink - `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 - `reportByCategory` LinksGetStoreReportByCategoryLink - `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 - `reportByProduct` LinksGetStoreReportByProductLink - `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 - `optimiseAll` LinksOptimiseAllLink - `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 - `optimise` LinksOptimiseLink - `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 - `optimiseByChannel` LinksOptimiseByChannelLink - `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 - `optimiseByCategory` LinksOptimiseByCategoryLink - `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 - `optimiseByProduct` LinksOptimiseByProductLink - `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 - `reportFilters` LinksGetReportFiltersLink, 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 - `rules` LinksGetRulesLink - `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 ## Other responses - `404` — Store or resource 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/revisions/557b7feddf8a/schema)