Get product by item code | Cata API

curl http://localhost:8080/api/v1/products/string \
     -H "X-Tenant-ID: string" \
     -H "X-Api-Key: <apiKey>"

{
  "id": "string",
  "itemCode": "string",
  "name": "string",
  "originalName": "string",
  "internalName": "string",
  "shortDescription": "string",
  "originalShortDescription": "string",
  "description": "string",
  "originalDescription": "string",
  "slug": "string",
  "mainImageUrl": "string",
  "externalImageUrl": "string",
  "basePrice": 985.8656121256826,
  "specialPrice": 4599.470647402808,
  "visible": true,
  "pickupAvailable": false,
  "deliveryAvailable": false,
  "eatInAvailable": false,
  "sortNum": 1211,
  "publishStatus": "string",
  "productType": 2469,
  "isBundle": true,
  "isVariant": false,
  "taxOverride": 6715.181578028244,
  "taxOverrideDelivery": 1356.1439730852176,
  "taxOverrideEatIn": 4828.106891083328,
  "provider": "string",
  "posCategory": "string",
  "modifierGroups": [
    {
      "id": "string",
      "itemCode": "string",
      "name": "string",
      "inputType": "string",
      "sortNum": 2842,
      "minSelect": 4941,
      "maxSelect": 4071,
      "allowMultipleQty": true,
      "options": [
        {
          "id": "string",
          "itemCode": "string",
          "name": "string",
          "additionalPrice": 1413.232240436133,
          "sortNum": 6999,
          "asDefault": false,
          "visible": false,
          "taxOverride": 7528.153504957964
        },
        {
          "id": "string",
          "itemCode": "string",
          "name": "string",
          "additionalPrice": 2611.5166029512247,
          "sortNum": 8281,
          "asDefault": false,
          "visible": false,
          "taxOverride": 1983.5203064908203
        }
      ]
    },
    {
      "id": "string",
      "itemCode": "string",
      "name": "string",
      "inputType": "string",
      "sortNum": 2079,
      "minSelect": 4241,
      "maxSelect": 231,
      "allowMultipleQty": true,
      "options": [
        {
          "id": "string",
          "itemCode": "string",
          "name": "string",
          "additionalPrice": 294.34616640131804,
          "sortNum": 9756,
          "asDefault": false,
          "visible": false,
          "taxOverride": 4428.396646155878
        },
        {
          "id": "string",
          "itemCode": "string",
          "name": "string",
          "additionalPrice": 6699.701816461657,
          "sortNum": 2066,
          "asDefault": true,
          "visible": true,
          "taxOverride": 7530.240559622427
        }
      ]
    }
  ],
  "bundleSections": [
    {
      "id": "string",
      "itemCode": "string",
      "name": "string",
      "sortNum": 1464,
      "minSelection": 3150,
      "maxSelection": 1645,
      "items": [
        {
          "itemCode": "string",
          "price": 469.5570734022869,
          "sortNum": 2787
        },
        {
          "itemCode": "string",
          "price": 9566.730645147885,
          "sortNum": 3863
        }
      ]
    },
    {
      "id": "string",
      "itemCode": "string",
      "name": "string",
      "sortNum": 108,
      "minSelection": 9519,
      "maxSelection": 7723,
      "items": [
        {
          "itemCode": "string",
          "price": 7926.324423750501,
          "sortNum": 6153
        },
        {
          "itemCode": "string",
          "price": 410.55685613466954,
          "sortNum": 3722
        }
      ]
    }
  ],
  "createdAt": "1979-04-23T15:13:43.546Z",
  "updatedAt": "1969-07-06T11:00:33.061Z"
}

Returns the full flat product record (base fields, modifiers, per-store prices, bundle sections if applicable). Accepts either a partner API key or a user JWT.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

itemCodestringRequired

Unique product item code

Response

idstring

itemCodestring

namestring

originalNamestring

internalNamestring

shortDescriptionstring

originalShortDescriptionstring

descriptionstring

originalDescriptionstring

slugstring

mainImageUrlstring

externalImageUrlstring

basePricedouble

specialPricedouble

visibleboolean

pickupAvailableboolean

deliveryAvailableboolean

eatInAvailableboolean

sortNuminteger

publishStatusstring

productTypeinteger

isBundleboolean

isVariantboolean

taxOverridedouble

taxOverrideDeliverydouble

taxOverrideEatIndouble

providerstring

posCategorystring

modifierGroupslist of objects

bundleSectionslist of objects

createdAtdatetime

updatedAtdatetime

Errors

401

Unauthorized Error

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors