OverviewPlatformsAPI ReferenceResources
Commerce

Add options

POSThttps://zernio.com/api/v1/commerce/products/{productId}/options

Adds option axes (e.g. Size, Color) and their values. With createVariants true the platform creates a variant for every new combination; otherwise existing variants take the first value.

PlatformsShopify

Authentication

AuthorizationBearer tokenRequired

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

Path parameters

productIdstringRequired

Platform-native id.

Body

application/json

What every request needs

accountIdstringRequired
optionsarray of objectRequired
namestringRequired
valuesarray of stringsRequired
Optional parameters1 field
createVariantsbooleanDefault false

Responses

Success· the request worked

Errors· the request failed

POST/v1/commerce/products/{productId}/options
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.commerce.createCommerceProductOptions({  path: {    productId: 'product_abc123',  },  body: {    accountId: 'account_abc123',    options: [      {        name: 'Example',        values: [          'string',        ],      },    ],  },});console.log(data);
{  "product": {    "id": "string",    "accountId": "string",    "platform": "shopify",    "title": "string",    "descriptionHtml": "string",    "handle": "string",    "vendor": "string",    "productType": "string",    "tags": [      "string"    ],    "status": "active",    "platformStatus": "string",    "featuredImage": {      "id": "string",      "url": "string",      "altText": "string"    },    "images": [      {        "id": "string",        "url": "string",        "altText": "string"      }    ],    "options": [      {        "name": "string",        "values": [          "string"        ]      }    ],    "variants": [      {        "id": "string",        "title": "string",        "sku": "string",        "barcode": "string",        "price": {          "amount": "string",          "currency": "string"        },        "compareAtPrice": {          "amount": "string",          "currency": "string"        },        "inventoryQuantity": 0,        "availableForSale": true,        "options": [          {            "name": "string",            "value": "string"          }        ]      }    ],    "totalInventory": 0,    "url": "string",    "seo": {      "title": "string",      "description": "string"    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "publishedAt": "2019-08-24T14:15:22Z",    "platformData": {}  }}
OpenAPI specification
Was this page helpful?