GET
/
catalog
/
collections
curl --request GET \
  --url https://sandbox-api.violet.io/v1/catalog/collections
{
  "content": [
    {
      "id": 123,
      "external_id": "<string>",
      "merchant_id": 123,
      "parent_id": 123,
      "name": "<string>",
      "handle": "<string>",
      "description": "<string>",
      "status": "INACTIVE",
      "type": "CUSTOM",
      "media": {
        "source_url": "<string>",
        "alt": "<string>",
        "height": 123,
        "width": 123,
        "date_created": "2023-11-07T05:31:56Z"
      },
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z"
    }
  ],
  "last": true,
  "total_pages": 123,
  "total_elements": 123,
  "first": true,
  "number_of_elements": 123,
  "size": 123,
  "number": 123,
  "empty": true,
  "next_page_cursor": "<string>",
  "pageable": {
    "page_number": 123,
    "page_size": 123,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 123,
    "paged": true,
    "unpaged": true
  },
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  }
}

Collection syncs can now be enabled using the Toggle Global Feature Flag endpoint.

Headers

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Query Parameters

page
integer
default:1
size
integer
default:20
exclude_hidden
boolean
default:true

Response

default - application/json
default response

The response is of type object.