Skip to content
Crossmart Docs

Set the listing’s item specifics

PUT
/api/v1/workspaces/{workspaceId}/products/{productId}/channels/{connectionId}/item-specifics
curl --request PUT \
  --url https://api.crossmart.io/api/v1/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/products/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/channels/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/item-specifics \
  --header 'Content-Type: application/json' \
  --data '{ "itemSpecifics": [ { "name": "Material", "values": [ "Stoneware" ] } ] }'

Replaces the item specifics set on the listing. They are sent on publish ahead of the ones Crossmart derives (such as Brand from the vendor). The listing is sent again when the channel holds it or its last publish failed.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspaceId
required
string format: uuid
productId
required
string format: uuid
connectionId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
itemSpecifics
required
Array<object>
<= 60 items
object
name
required
string
<= 40 characters

Example 

Material
values
required

Blank values are dropped; a specific left without values is removed

Array<string>
<= 30 items

Example 

[
  "Stoneware"
]

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
category
required
object
id
required
string
name
required

The category with its ancestors, as the channel shows it

string
aspects
required

Required first, then recommended, then optional; none without a category

Array<object>
object
name
required
string
required
required

The channel refuses listings in the category without it

boolean
usage
required
string
Allowed values: recommended optional
mode
required

selection_only takes one of values; free_text takes any text

string
Allowed values: free_text selection_only
multiple
required

Whether a listing may give it several values

boolean
values
required

The channel’s values, the first ones only

Array<string>
itemSpecifics
required
Array<object>
object
name
required
string
<= 40 characters
values
required

Blank values are dropped; a specific left without values is removed

Array<string>
<= 30 items

Example 

{
  "category": {
    "id": "20625",
    "name": "Home & Garden > Kitchen, Dining & Bar > Dinnerware & Serving Dishes > Mugs"
  },
  "aspects": [
    {
      "name": "Color",
      "usage": "recommended",
      "mode": "free_text"
    }
  ],
  "itemSpecifics": [
    {
      "name": "Material",
      "values": [
        "Stoneware"
      ]
    }
  ]
}