Catalogs

Prerequisites

• access_token from Headless API Authentication

• cultureCode, e.g. en-US (string)

• priceGroupId from the cart or from Price Groups

Get Catalogs

Optional Parameters

• maxItems, limits the number of results returned. in Pagination

• nextPagingToken, required to fetch the next page. Read more in Pagination

Request

curl -D- -X GET <base_url>/api/v1/catalogs?cultureCode=<cultureCode>&priceGroupId=<priceGroupId>&maxItems=<maxItems>&nextPagingToken=<nextPagingToken> \
    -H 'Authorization: Bearer <ACCESS_TOKEN>'
    -H 'Content-Type: application/json' \

Response

{
    "nextPagingToken": "{pagingToken | null}",
    "catalogs": [
        {
            "id": "{catalogId}",
            "name": "{catalogName}"
        }
    ]
}

Error Handling

Error	Description
BadRequest (400)	Invalid Price Group; Invalid cultureCode.
Unauthorized (401)	The token is expired.
Forbidden (403)	The token does not have access to this endpoint.

Error Response Example

{
"errors":
    [
        {
            "error-description": "Invalid Price Group.",
            "error": "BadRequest"
        }
    ]
}

Related Articles

pageError Handling