VariantMetafield

Metafields are custom variables that may be attached to various resources, like variants, allowing you to store additional information.

GET All variant metafields
GET Number of metafields
GET Retrieve a metafield
POST Create a metafield
PUT Update a metafield
DELETE Delete a metafield

Example object

{
    "variantMetafield": {
        "id": 5496385,
        "createdAt": "2019-08-07T19:13:46+00:00",
        "updatedAt": "2019-08-07T19:13:46+00:00",
        "key": "external_email",
        "value": "[email protected]"
    }
}

Properties

id	The unique numeric identifier for the variant metafield. {“id”: {id}}
createdAt	The date and time when the variant metafield was created. (format: ISO-8601){“createdAt”: “2019-08-07T19:13:46+00:00”}
updatedAt	The date and time when the variant metafield was last updated. (format: ISO-8601){“updatedAt”: “2019-08-07T19:13:46+00:00”}
key	A unique key describing this metafield {“key”: “external_email”}
value	The value of this metafield. {“value”: “[email protected]”}

GET All variant metafields

Returns all the variantMetafield objects associated with the variant.

Definition

GET /variants/{variant_id}/metafields.json

Example request

curl https://api.shoplightspeed.com/en/variants/{variant_id}/metafields.json \
  -u {key}:{secret}

<?php $api->variantsMetafields->get($variant_id);

Example response

{
    "variantMetafields": [
        {
            "id": 5496385,
            "createdAt": "2019-08-07T19:13:46+00:00",
            "updatedAt": "2019-08-07T19:13:46+00:00",
            "key": "external_email",
            "value": "[email protected]"
        }
    ]
}

Arguments

No arguments available.

Filters

limit	Number of results. {(default: 50) (maximum: 250)}
page	Page to show. {(default: 1)}
since_id	Restrict results to after the specified ID. {(default: 0)}
created_at_min	Show variantMetafields created after date. {(format: YYYY-MM-DD HH:MM:SS)}
created_at_max	Show variantMetafields created before date. {(format: YYYY-MM-DD HH:MM:SS)}
updated_at_min	Show variantMetafields last updated after date. {(format: YYYY-MM-DD HH:MM:SS)}
updated_at_max	Show variantMetafields last updated before date. {(format: YYYY-MM-DD HH:MM:SS)}
fields	Comma-separated list of fields to include in the response. {(format: id,createdAt)}

GET Number of metafields

Returns the number of variantMetafield objects associated with the variant.

Definition

GET /variants/{variant_id}/metafields/count.json

Example request

curl https://api.shoplightspeed.com/en/variants/{variant_id}/metafields/count.json \
  -u {key}:{secret}

<?php $api->variantsMetafields->count($variant_id);

Example response

{
  "count": 1
}

Arguments

No arguments available.

Filters

limit	Number of results. {(default: 50) (maximum: 250)}
page	Page to show. {(default: 1)}
since_id	Restrict results to after the specified ID. {(default: 0)}
created_at_min	Show variantMetafields created after date. {(format: YYYY-MM-DD HH:MM:SS)}
created_at_max	Show variantMetafields created before date. {(format: YYYY-MM-DD HH:MM:SS)}
updated_at_min	Show variantMetafields last updated after date. {(format: YYYY-MM-DD HH:MM:SS)}
updated_at_max	Show variantMetafields last updated before date. {(format: YYYY-MM-DD HH:MM:SS)}
fields	Comma-separated list of fields to include in the response. {(format: id,createdAt)}

GET Retrieve a metafield

Returns the single variantMetafield associated with the variant.

Definition

GET /variants/{variant_id}/metafields/{variantMetafield_id}.json

Example request

curl https://api.shoplightspeed.com/en/variants/{variant_id}/metafields/{variantMetafield_id}.json \
  -u {key}:{secret}

<?php $api->variantsMovements->get($variant_id, $variantMetafield_id);

Example response

{
    "variantMetafield": {
        "id": 5496385,
        "createdAt": "2019-08-07T19:13:46+00:00",
        "updatedAt": "2019-08-07T19:13:46+00:00",
        "key": "external_email",
        "value": "[email protected]"
    }
}

Arguments

id	The unique numeric identifier for the variant metafield. {“id”: {id}}

POST Create a metafield

Create a new variantMetafield and associate it with the variant.

Definition

POST /variants/{variant_id}/metafields.json

Example request

curl -x POST https://api.shoplightspeed.com/en/variants/{variant_id}/metafields.json \
  -u {key}:{secret} \
  -d variantMetafields[key]="external_email" \
  -d variantMetafields[value]="[email protected]"

<?php $api->variantsMetafields->create([
    "key"   => external_email,
    "value" => "[email protected]"
]);

Example Json payload

{
  "variantMetafield": {
    "key": "external_email",
    "value": "[email protected]"
  }
}

Example response

{
    "variantMetafield": {
        "id": 5496385,
        "createdAt": "2019-08-07T19:13:46+00:00",
        "updatedAt": "2019-08-07T19:13:46+00:00",
        "key": "external_email",
        "value": "[email protected]"
    }
}

Arguments

key	A unique key describing this metafield. {“key”: “external_email”}
value	The value of this metafield. {“value”: “[email protected]”}

PUT Update a metafield

Update an existing variantMetafield object that is associated with the variant.

Definition

PUT /variants/{variant_id}/metafields/{variantMetafield_id}.json

Example request

curl -X PUT https://api.shoplightspeed.com/en/variants/{variant_id}/metafields.json \
  -u {key}:{secret} \
  -d variantMetafields[key]="external_email" \
  -d variantMetafields[value]="[email protected]"

<?php $api->variantsMetafields->update($id, [
    "key"    => external_email,
    "value"   => "[email protected]"
]);

Example Json payload

{
  "variantMetafield": {
    "key": "external_email",
    "value": "[email protected]"
  }
}

Example response

{
    "variantMetafield": {
        "id": 5496385,
        "createdAt": "2019-08-07T19:13:46+00:00",
        "updatedAt": "2019-08-07T19:13:46+00:00",
        "key": "external_email",
        "value": "[email protected]"
    }
}

Arguments

key	A unique key describing this metafield. {“key”: “external_email”}
value	The value of this metafield. {“value”: “[email protected]”}

DELETE Delete a metafield

Delete an existing variantMetafield that is associated with the variant.

Definition

DELETE /variants/{variant_id}/metafields/{variantMetafield_id}.json

Example request

curl -X DELETE https://api.shoplightspeed.com/en/variants/{variant_id}/metafields/{variantMetafield_id}.json \
  -u {key}:{secret} \

<?php $api->variantsMetafields->delete($variant_id , $variantMetafield_id);

Example response

HTTP/1.1 204 No Content

Arguments

id	The unique numeric identifier for the variant metafield. {“id”: {id}}