OverviewProductsPlatformsAPI ReferenceResources
Commerce

Get a product

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

One product with all its variants, options and images. Needs products.read. 404 product_not_found when the id does not exist in the store.

PlatformsShopify

Authentication

AuthorizationBearer tokenRequired

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

Path parameters

productIdstringRequired

Platform-native product id.

Query parameters

accountIdstringRequired

Connected store SocialAccount id.

Responses

Success· the request worked

Errors· the request failed

GET/v1/commerce/products/{productId}
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.commerce.getCommerceProduct({  path: {    productId: 'product_abc123',  },  query: {    accountId: 'account_abc123',  },});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?