Sign in

v1

latestSwagger 2.0BeezUP2026-07-13254876845.8 KB
Channel Catalogs - Global

Add a new channel catalog

post/v2/user/channelCatalogs/

Request body

channelIdstring guid required

The channel identifier

storeIdstring guid required

The store identifier

Example request

{
  "channelId": "2dc136a7-0d3d-4cc9-a825-a28a42c53e28",
  "storeId": "64f43358-63a1-47f7-97ec-0301fc39956b"
}

Response

When the channel has been successfully added for this store

labelstring

The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.

docUrlstring uri

The documentation related to this operation.

descriptionstring

The description of the link

hrefstring required

Indicate the relative uri for this link

operationIdstring

The operationId to call.

method'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD'

Indicate the http method to use on this link

parametersobject
urlTemplatedboolean

indicates whether the href is templated or not

allRequiredParamsProvidedboolean

indicates whether all required params have been provided

allOptionalParamsProvidedboolean

indicates whether all optionals params have been provided

Example response

{
  "href": "/v2/user/channelCatalogs/6d6b04de-406b-4539-8e7e-bf3e8da5dfb0",
  "method": "GET"
}