Skip to content

Add products to the store

POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/products/add
curl --request POST \
--url https://api.crossmart.io/api/v1/workspaces/example/channel-connections/example/products/add \
--header 'Content-Type: application/json' \
--data '{ "productIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

They stay until removed and are published at once. Refused (402) without changes when the plan has no room for the active listings they would add.

workspaceId
required
string
connectionId
required
string
Media typeapplication/json
object
productIds
required
Array<string>
>= 1 items <= 250 items

Example generated

{
"productIds": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
]
}
Media typeapplication/json
object
count
required

Products added or removed

number

Example generated

{
"count": 1
}

The organization’s plan does not allow this (ENTITLEMENTS_ENFORCED is on). code and feature say why; upgrading the plan resolves it.

Media typeapplication/json
object
statusCode
required
number
error
required
string
code
required
string
Allowed values: plan_limit_reached plan_feature_not_included
message
required
string
feature
required
string
Allowed values: active_listings channel_connections workspaces members api_keys ai_credits autonomous_agents bring_your_own_key
plan
required

The code of the organization’s plan

string
limit
required

Null is unlimited

number
nullable
usage
required
number
requested
required

How many more the request asked for

number

Example

{
"statusCode": 402,
"error": "Payment Required",
"code": "plan_limit_reached",
"message": "The Free plan includes 2 connected channels, and 2 are in use. Upgrade the plan to add more.",
"feature": "active_listings",
"plan": "free"
}