Commerce
Add or remove products in a collection
Adds and/or removes hand-picked products. Products a collection
includes through its own rules are not affected. pending is true
when the platform finishes the change in the background; the product
count then catches up a few seconds later.
PlatformsShopify
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Path Parameters
collectionId*string
Platform-native collection id.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
At least one product id in add or remove.
Response Body
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.commerce.changeCommerceCollectionProducts({ path: { collectionId: 'collection_abc123', }, body: { accountId: 'account_abc123', },});console.log(data);{ "collection": { "id": "string", "accountId": "string", "platform": "shopify", "title": "string", "handle": "string", "descriptionHtml": "string", "image": { "id": "string", "url": "string", "altText": "string" }, "sortOrder": "manual", "productCount": 0, "seo": { "title": "string", "description": "string" }, "updatedAt": "2019-08-24T14:15:22Z", "platformData": {} }, "pending": true}Was this page helpful?