SalesChannelMarketPlaceAttributeSetConfig

Create an attribute set config for a category node

post
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Body
attribute_setintegerOptional
Responses
chevron-right
201

Successfully created the attribute set config for the category node.

application/json
post
/api/v1/channel/{channel_id}/attribute_set_configs/category_node/{id}

Retrieve a specific attribute set config

get
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
get
/api/v1/channel/{channel_id}/attribute_set_configs/{id}/

Fully update an attribute set config

put
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Body

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
put
/api/v1/channel/{channel_id}/attribute_set_configs/{id}/

Delete an attribute set config

delete
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
delete
/api/v1/channel/{channel_id}/attribute_set_configs/{id}/

No content

Partially update an attribute set config

patch
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Body

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
patch
/api/v1/channel/{channel_id}/attribute_set_configs/{id}/

List all attribute set configs

get

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

Authorizations
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
get
/api/v1/channel/{channel_id}/attribute_set_configs/

Create an attribute set config

post
Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Body

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
chevron-right
201

Successfully created the attribute set config.

application/json
post
/api/v1/channel/{channel_id}/attribute_set_configs/

Last updated

Was this helpful?