SalesChannelAttributeConfig

Retrieve a specific sales channel attribute configuration

get

Authorizations

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 sales channel attribute configuration.

application/json

403

Forbidden

404

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

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

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

{
  "pk": 1,
  "attribute_set": 1,
  "attribute_set_name": "text",
  "attribute": 1,
  "attribute_name": "text",
  "locale_attribute_schema": 1,
  "attribute_remote_id": "text",
  "is_required": true,
  "is_variant": true,
  "is_custom": true,
  "is_image_attribute": true,
  "is_meta": true,
  "modified_date": "2025-05-22T10:03:30.527Z"
}

Fully update a sales channel attribute configuration

put

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

locale_attribute_schemaintegerOptional

is_requiredbooleanOptional

is_variantbooleanOptional

is_custombooleanOptional

is_metabooleanOptional

is_image_attributebooleanOptional

Responses

200

Successfully updated the attribute configuration.

application/json

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

HTTPcURLJavaScriptPython

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

{
  "locale_attribute_schema": 1,
  "is_required": true,
  "is_variant": true,
  "is_custom": true,
  "is_meta": true,
  "is_image_attribute": true
}

{
  "pk": 1,
  "attribute_set": 1,
  "attribute": 1,
  "locale_attribute_schema": 1,
  "attribute_remote_id": "text",
  "is_required": true,
  "is_variant": true,
  "is_custom": true,
  "is_image_attribute": true,
  "is_meta": true,
  "modified_date": "2025-05-22T10:03:30.527Z",
  "created_date": "2025-05-22T10:03:30.527Z"
}

Delete a specific sales channel attribute configuration

delete

Authorizations

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 sales channel attribute configuration.

403

Forbidden

404

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

application/json

500

Server Error

delete

HTTPcURLJavaScriptPython

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

No content

Partially update a sales channel attribute configuration

patch

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

locale_attribute_schemaintegerOptional

is_requiredbooleanOptional

is_variantbooleanOptional

is_custombooleanOptional

is_metabooleanOptional

is_image_attributebooleanOptional

Responses

200

Successfully updated the attribute configuration.

application/json

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

HTTPcURLJavaScriptPython

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

{
  "locale_attribute_schema": 1,
  "is_required": true,
  "is_variant": true,
  "is_custom": true,
  "is_meta": true,
  "is_image_attribute": true
}

{
  "pk": 1,
  "attribute_set": 1,
  "attribute": 1,
  "locale_attribute_schema": 1,
  "attribute_remote_id": "text",
  "is_required": true,
  "is_variant": true,
  "is_custom": true,
  "is_image_attribute": true,
  "is_meta": true,
  "modified_date": "2025-05-22T10:03:30.527Z",
  "created_date": "2025-05-22T10:03:30.527Z"
}

List all sales channel attribute configurations

get

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

attributeinteger · int64Optional

Filter by related attribute ID

Example: 1

attribute_setinteger · int64Optional

Filter by related attribute set ID

Example: 1

category__ininteger[]Optional

Filter by multiple category node IDs.

attribute_set__ininteger[]Optional

Filter by multiple attribute set IDs.

attribute_set__name__icontainsstringOptional

Filter by attribute set names case-insensitive containing a specific string.

locale_attribute_schemaintegerOptional

Filter by locale attribute schema.

attribute_remote_idstringOptional

Filter by remote ID of the attribute.

is_requiredbooleanOptional

Filter by is_required field.

is_variantbooleanOptional

Filter by is_variant field.

is_custombooleanOptional

Filter by custom attributes.

is_image_attributebooleanOptional

Filter by image attributes.

is_metabooleanOptional

Filter by meta attributes.

Responses

200

A list of sales channel attribute configurations.

application/json

403

Forbidden

500

Server Error

get

HTTPcURLJavaScriptPython

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

[
  {
    "pk": 1,
    "attribute_set": 1,
    "attribute_set_name": "text",
    "attribute": 1,
    "attribute_name": "text",
    "locale_attribute_schema": 1,
    "attribute_remote_id": "text",
    "is_required": true,
    "is_variant": true,
    "is_custom": true,
    "is_image_attribute": true,
    "is_meta": true,
    "modified_date": "2025-05-22T10:03:30.527Z"
  }
]

Create a new sales channel attribute configuration

post

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

pkintegerRead-onlyOptional

Primary key of the attribute configuration.

attribute_setintegerOptional

ID of the associated attribute set.

attributeintegerOptional

ID of the associated attribute.

locale_attribute_schemainteger | nullableOptional

ID of the locale-specific attribute schema.

attribute_remote_idstring | nullableOptional

Remote identifier for the attribute.

is_requiredbooleanOptional

Indicates if the attribute is required. Defaults to False.

is_variantbooleanOptional

Indicates if the attribute is a variant. Defaults to False.

is_custombooleanOptional

Indicates if the attribute is custom. Defaults to False.

is_image_attributebooleanOptional

Indicates if the attribute is an image attribute. Defaults to False.

is_metabooleanOptional

Indicates if the attribute is a meta attribute. Defaults to False.

modified_datestring · date-timeOptional

Timestamp of the last modification.

created_datestring · date-timeRead-onlyOptional

Timestamp when this market place attribute config was created.

Responses

201

Successfully created a new sales channel attribute configuration.

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

HTTPcURLJavaScriptPython

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

{
  "attribute_set": 1,
  "attribute": 1,
  "locale_attribute_schema": 1,
  "attribute_remote_id": "text",
  "is_required": true,
  "is_variant": true,
  "is_custom": true,
  "is_image_attribute": true,
  "is_meta": true,
  "modified_date": "2025-05-22T10:03:30.527Z"
}

{
  "pk": 1,
  "attribute_set": 1,
  "attribute": 1,
  "locale_attribute_schema": 1,
  "attribute_remote_id": "text",
  "is_required": true,
  "is_variant": true,
  "is_custom": true,
  "is_image_attribute": true,
  "is_meta": true,
  "modified_date": "2025-05-22T10:03:30.527Z",
  "created_date": "2025-05-22T10:03:30.527Z"
}

List all sales channel attribute configurations with details

get

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

attributeinteger · int64Optional

Filter by related attribute ID

Example: 1

attribute_setinteger · int64Optional

Filter by related attribute set ID

Example: 1

category__ininteger[]Optional

Filter by multiple category node IDs.

attribute_set__ininteger[]Optional

Filter by multiple attribute set IDs.

attribute_set__name__icontainsstringOptional

Filter by attribute set names case-insensitive containing a specific string.

locale_attribute_schemaintegerOptional

Filter by locale attribute schema.

attribute_remote_idstringOptional

Filter by remote ID of the attribute.

is_requiredbooleanOptional

Filter by is_required field.

is_variantbooleanOptional

Filter by is_variant field.

is_custombooleanOptional

Filter by custom attributes.

is_image_attributebooleanOptional

Filter by image attributes.

is_metabooleanOptional

Filter by meta attributes.

Responses

200

A list of sales channel attribute configurations with details.

application/json

403

Forbidden

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/attribute_configs/detailed_list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "pk": 1,
    "attribute_set": {
      "pk": 1,
      "name": "text",
      "channel": 1,
      "remote_id": "text",
      "created_date": "2025-05-22T10:03:30.527Z",
      "modified_date": "2025-05-22T10:03:30.527Z"
    },
    "attribute": {
      "pk": 1,
      "name": "text",
      "channel": 1,
      "locale_attribute_schema": 1,
      "modified_date": "2025-05-22T10:03:30.527Z"
    },
    "locale_attribute_schema": 1,
    "attribute_remote_id": "text",
    "is_required": true,
    "is_variant": true,
    "is_custom": true,
    "is_image_attribute": true,
    "is_meta": true
  }
]