SalesChannelMarketPlaceAttribute

PreviousSalesChannelMappedProduct NextSalesChannelOrderItem

Was this helpful?

Delete a marketplace attribute

delete

Delete an existing marketplace attribute

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Attribute deleted successfully

400

Bad Request

401

Unauthorized

delete

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

No content

List all attributes for a channel

get

Retrieve a list of all attributes associated with a specific channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

Responses

200

Successful response

application/json

400

Bad Request

401

Unauthorized

get

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

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "pk": 1,
      "name": "text",
      "channel": 1,
      "locale_attribute_schema": 1,
      "modified_date": "2025-05-22T10:02:51.432Z"
    }
  ]
}

Get a specific marketplace attribute by ID

get

Retrieve details of a marketplace attribute by its unique 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

get

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

{
  "pk": 1,
  "name": "text",
  "channel": 1,
  "locale_attribute_schema": 1,
  "modified_date": "2025-05-22T10:02:51.432Z"
}

Update a marketplace attribute

put

Update an existing marketplace attribute

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

Name of the attribute

channelintegerOptional

Associated channel ID

locale_attribute_schemainteger | nullableOptional

Associated schema ID, can be null

Responses

200

Successfully updated

application/json

400

Invalid request

404

Attribute not found

put

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

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

{
  "pk": 1,
  "name": "text",
  "channel": 1,
  "locale_attribute_schema": 1,
  "modified_date": "2025-05-22T10:02:51.432Z"
}

Partial update of a marketplace attribute

patch

Update a specific field of a marketplace attribute

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

Name of the attribute

channelintegerOptional

Associated channel ID

locale_attribute_schemainteger | nullableOptional

Associated schema ID, can be null

Responses

200

Successfully updated

application/json

400

Invalid request

404

Attribute not found

patch

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

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

{
  "pk": 1,
  "name": "text",
  "channel": 1,
  "locale_attribute_schema": 1,
  "modified_date": "2025-05-22T10:02:51.432Z"
}

Create a new marketplace attribute

post

Create a new marketplace attribute for a specific channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

namestring · max: 255Required

Name of the attribute

channelintegerRequired

Associated channel ID

locale_attribute_schemainteger | nullableOptional

Associated schema ID, can be null

Responses

201

Successfully created

application/json

400

Invalid request

post

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

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

{
  "pk": 1,
  "name": "text",
  "channel": 1,
  "locale_attribute_schema": 1,
  "modified_date": "2025-05-22T10:02:51.432Z"
}