Create a json metafield

Send a structured object as a single JSON metafield.

Before you start

Paste the raven's Get Code output into your theme first — that Liquid computes the signature and defines window.FR_<RESOURCE>_<KEY>. See Quick Start. The snippets below assume it is present, and use cfg for it.

Sending a value

value must be a JSON string, not a JSON object.

Pass JSON.stringify(...). Sending a bare object fails validation with 422 Invalid JSON format — the server parses value as a string, so an object never reaches the parser intact. The code the Get Code panel generates stringifies for exactly this reason.

async function submit(value) {
  var cfg = window.FR_CUSTOMER_MY_KEY;              // from the Get Code panel

  var res = await fetch('/apps/raven/create_metafield', {
    method: 'PUT',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      raven: {
        raven_id:   cfg.ravenId,
        resource_id: cfg.resourceId,
        raven_mac:  cfg.ravenMac,
        value:      value
      }
    })
  });

  if (res.status === 429) return console.warn('Busy — retry shortly.');
  var data = await res.json().catch(function () { return {}; });
  if (!res.ok) return console.error(data.message || 'Rejected.');
  console.log(data.message);            // "Sit tight the raven is on it!"
}

submit(JSON.stringify({ colour: 'blue', size: 'M', updatedAt: Date.now() }));

A JSON raven is also the only type that can mirror submissions into a Shopify metaobject — see Metaobject sync.