SalesChannelMarketPlaceAttributeSetConfig

Create an attribute set config for a category node

post

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

attribute_setintegerOptional

Responses

201

Successfully created the attribute set config for the category node.

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

500

Server Error

post

/api/v1/channel/{channel_id}/attribute_set_configs/category_node/{id}

HTTPcURLJavaScriptPython

POST /api/v1/channel/{channel_id}/attribute_set_configs/category_node/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "attribute_set": 1
}

{
  "pk": 1,
  "attribute_set": 1,
  "object_id": 1,
  "content_type": "text",
  "created_date": "2026-03-06T21:25:00.695Z",
  "modified_date": "2026-03-06T21:25:00.695Z",
  "url": "https://example.com"
}

Retrieve a specific attribute set config

get

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Successfully retrieved the attribute set config.

application/json

or

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/attribute_set_configs/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/attribute_set_configs/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "attribute_set": 1,
  "object_id": 1,
  "content_type": "text",
  "created_date": "2026-03-06T21:25:00.695Z",
  "modified_date": "2026-03-06T21:25:00.695Z",
  "url": "https://example.com"
}

Fully update an attribute set config

put

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

Input schema for creating or updating a MarketPlaceAttributeSetConfig instance.

attribute_setintegerOptional

ID of the MarketPlaceAttributeSet to associate with the content object.

object_idintegerOptional

ID of the target object to be linked to the attribute set.

content_typestringRequired

Model name of the content type for the target object (must be a valid ContentType.model value).

Responses

200

Successfully updated the attribute set config.

application/json

Represents a configuration linking a marketplace attribute set to a target object (like a category node) via a generic foreign key.

pkintegerOptional

Primary key of the configuration instance.

attribute_setintegerOptional

ID of the related MarketPlaceAttributeSet.

object_idintegerOptional

ID of the target object this configuration applies to (e.g., a CategoryNode ID).

content_typestringOptional

The model name of the target object's content type (e.g., 'categorynode').

created_datestring · date-timeOptional

Timestamp of when the configuration was created.

modified_datestring · date-timeOptional

Timestamp of the last modification.

urlstring · uri · nullableOptional

Fully qualified URL of the resource (present only in hyperlinked serializers).

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

put

/api/v1/channel/{channel_id}/attribute_set_configs/{id}/

HTTPcURLJavaScriptPython

PUT /api/v1/channel/{channel_id}/attribute_set_configs/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "attribute_set": 1,
  "object_id": 1,
  "content_type": "text"
}

{
  "pk": 1,
  "attribute_set": 1,
  "object_id": 1,
  "content_type": "text",
  "created_date": "2026-03-06T21:25:00.695Z",
  "modified_date": "2026-03-06T21:25:00.695Z",
  "url": "https://example.com"
}

Delete an attribute set config

delete

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Successfully deleted the attribute set config.

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

delete

/api/v1/channel/{channel_id}/attribute_set_configs/{id}/

HTTPcURLJavaScriptPython

DELETE /api/v1/channel/{channel_id}/attribute_set_configs/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Partially update an attribute set config

patch

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

Input schema for creating or updating a MarketPlaceAttributeSetConfig instance.

attribute_setintegerOptional

ID of the MarketPlaceAttributeSet to associate with the content object.

object_idintegerOptional

ID of the target object to be linked to the attribute set.

content_typestringRequired

Model name of the content type for the target object (must be a valid ContentType.model value).

Responses

200

Successfully updated the attribute set config.

application/json

Represents a configuration linking a marketplace attribute set to a target object (like a category node) via a generic foreign key.

pkintegerOptional

Primary key of the configuration instance.

attribute_setintegerOptional

ID of the related MarketPlaceAttributeSet.

object_idintegerOptional

ID of the target object this configuration applies to (e.g., a CategoryNode ID).

content_typestringOptional

The model name of the target object's content type (e.g., 'categorynode').

created_datestring · date-timeOptional

Timestamp of when the configuration was created.

modified_datestring · date-timeOptional

Timestamp of the last modification.

urlstring · uri · nullableOptional

Fully qualified URL of the resource (present only in hyperlinked serializers).

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch

/api/v1/channel/{channel_id}/attribute_set_configs/{id}/

HTTPcURLJavaScriptPython

PATCH /api/v1/channel/{channel_id}/attribute_set_configs/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "attribute_set": 1,
  "object_id": 1,
  "content_type": "text"
}

{
  "pk": 1,
  "attribute_set": 1,
  "object_id": 1,
  "content_type": "text",
  "created_date": "2026-03-06T21:25:00.695Z",
  "modified_date": "2026-03-06T21:25:00.695Z",
  "url": "https://example.com"
}

List all attribute set configs

get

Fetches a list of all attribute set configs for the specified sales channel.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

content_type__modelstringOptional

Filter by content type model

attribute_setinteger · int64Optional

Filter by related attribute set ID

Example: 1

object_idstringOptional

Filter by object ID

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

Responses

200

A list of attribute set configs.

application/json

or

403

Forbidden

500

Server Error

get

/api/v1/channel/{channel_id}/attribute_set_configs/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/attribute_set_configs/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "pk": 1,
    "url": "https://example.com",
    "attribute_set": "https://example.com",
    "object_id": 1,
    "content_type": "https://example.com",
    "created_date": "2026-03-06T21:25:00.695Z",
    "modified_date": "2026-03-06T21:25:00.695Z"
  }
]

Create an attribute set config

post

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

application/json

Input schema for creating or updating a MarketPlaceAttributeSetConfig instance.

attribute_setintegerOptional

ID of the MarketPlaceAttributeSet to associate with the content object.

object_idintegerOptional

ID of the target object to be linked to the attribute set.

content_typestringRequired

Model name of the content type for the target object (must be a valid ContentType.model value).

Responses

201

Successfully created the attribute set config.

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

500

Server Error

post

/api/v1/channel/{channel_id}/attribute_set_configs/

HTTPcURLJavaScriptPython

POST /api/v1/channel/{channel_id}/attribute_set_configs/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "attribute_set": 1,
  "object_id": 1,
  "content_type": "text"
}

{
  "pk": 1,
  "attribute_set": 1,
  "object_id": 1,
  "content_type": "text",
  "created_date": "2026-03-06T21:25:00.695Z",
  "modified_date": "2026-03-06T21:25:00.695Z",
  "url": "https://example.com"
}