Add products to the store
POST
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/products/add
const url = 'https://api.crossmart.io/api/v1/workspaces/example/channel-connections/example/products/add';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"productIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspaceId
required
string
connectionId
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
productIds
required
Array<string>
Example generated
{ "productIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ]}Responses
Section titled “Responses”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
message
required
string
feature
required
string
plan
required
The code of the organization’s plan
string
limit
required
Null is unlimited
number
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"}