GET
/
catalog
/
collections
/
{collection_id}
curl --request GET \
  --url https://sandbox-api.violet.io/v1/catalog/collections/{collection_id}
{
  "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"
}

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

Path Parameters

collection_id
integer
required

Response

default - application/json
id
integer
external_id
string

External ID

merchant_id
integer
required

Merchant ID

parent_id
integer

Parent ID for platforms that have a parent-child collection structure.

name
string

Name of this collection

handle
string

Handle of this collection

description
string

Description of this collection

status
enum<string>

Status of this collection

Available options:
INACTIVE,
ACTIVE,
SYNC_IN_PROGRESS,
FOR_DELETION
type
enum<string>

Type of this collection

Available options:
CUSTOM,
AUTOMATED
media
object

Collection Media

date_created
string

Date of creation of this collection on platform

date_last_modified
string

Date of last update of this collection on platform

Was this page helpful?

Get All Merchant CollectionsGet Collection Offers