SalesChannelAttributeSchemas

Get an attribute schema by ID

get

Returns an attribute schema by its ID

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Successful response

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

get

HTTPcURLJavaScriptPython

GET /api/channel/{channel_id}/attribute_schemas/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "name": "text",
  "schema": {},
  "channel": 1,
  "created_date": "2025-05-22T10:09:45.479Z",
  "modified_date": "2025-05-22T10:09:45.479Z"
}

Update an attribute schema

put

Update an existing attribute schema

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

namestring · max: 255Required

schemaobjectRequired

channelintegerRequired

Sales channel id

Responses

200

Attribute schema updated successfully

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

put

HTTPcURLJavaScriptPython

PUT /api/channel/{channel_id}/attribute_schemas/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "name": "text",
  "schema": {},
  "channel": 1
}

{
  "pk": 1,
  "name": "text",
  "schema": {},
  "channel": 1,
  "created_date": "2025-05-22T10:09:45.479Z",
  "modified_date": "2025-05-22T10:09:45.479Z"
}

Partial update an attribute schema

patch

Partial update an existing attribute schema

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

namestring · max: 255Optional

schemaobjectOptional

channelintegerOptional

Sales channel id

Responses

200

Attribute schema updated successfully

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

patch

HTTPcURLJavaScriptPython

PATCH /api/channel/{channel_id}/attribute_schemas/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "name": "text",
  "schema": {},
  "channel": 1
}

{
  "pk": 1,
  "name": "text",
  "schema": {},
  "channel": 1,
  "created_date": "2025-05-22T10:09:45.479Z",
  "modified_date": "2025-05-22T10:09:45.479Z"
}

List attribute schemas for a sales channel

get

Returns a list of attribute schemas for a sales channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

namestringOptional

Filters by name

Responses

200

Successful response

application/json

400

Bad Request

get

HTTPcURLJavaScriptPython

GET /api/channel/{channel_id}/attribute_schemas/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "pk": 1,
    "name": "text",
    "schema": {},
    "channel": 1,
    "created_date": "2025-05-22T10:09:45.479Z",
    "modified_date": "2025-05-22T10:09:45.479Z"
  }
]

Create a new attribute schema

post

Create a new attribute schema for a sales channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

namestring · max: 255Required

schemaobjectOptional

channelintegerOptional

Sales channel id

Responses

201

Attribute schema created successfully

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

post

HTTPcURLJavaScriptPython

POST /api/channel/{channel_id}/attribute_schemas/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "name": "text",
  "schema": {},
  "channel": 1
}

{
  "pk": 1,
  "name": "text",
  "schema": {},
  "channel": 1,
  "created_date": "2025-05-22T10:09:45.479Z",
  "modified_date": "2025-05-22T10:09:45.479Z"
}