TDV Adapter for Shopify

Build 24.0.9060

Metafields

Retrieves a list of metafields that belong to one or many resource IDs.

Table-Specific Information

OwnerResource or the metafield Id is required for any query against Metafields.

OwnerResource must be one of the following values:

  • shop
  • draft_order
  • product
  • variant
  • page
  • article
  • order
  • customer
  • collection
  • blog
  • product_image

Any other value will run the query against "shop" instead.

Select

The adapter uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The adapter processes other filters client-side within the adapter.

  • Id supports the '=,IN' comparison operators.
  • OwnerId supports the '=,IN' comparison operators.
  • OwnerResource supports the '=,IN' comparison operators.

OwnerResource is a required column, and eligible values include "product","variant","shop","draft_order","order","customer","collection".

For example, the following queries are processed server side:

	SELECT * FROM Metafields WHERE OwnerResource = 'product'
	SELECT * FROM Metafields WHERE OwnerResource = 'product' AND Id = 'gid://shopify/Metafield/19334473318423'
	SELECT * FROM Metafields WHERE OwnerId = 'gid://shopify/ProductVariant/39378393497623' AND OwnerResource = 'variant'
	SELECT * FROM Metafields WHERE OwnerId IN ('gid://shopify/ProductVariant/39378393497623', 'gid://shopify/Product/1418248224791') AND OwnerResource = 'variant'

Insert

The following columns can be used to create a new record:

Namespace, Key, Value, Type, OwnerId

Delete

You can delete entries by specifying the following column:

Id

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique ID of the metafield.

LegacyResourceId Long True

The ID of the corresponding resource in the REST Admin API.

Namespace String True

A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps.

Key String True

The name of the metafield.

Value String True

The information to be stored as metadata.

Type String True

The metafield's information type.

Description String True

A description of the information that the metafield contains.

OwnerId String True

The ID of the resource that the metafield is attached to.

OwnerResource String True

The type of resource that the metafield is attached to.

CreatedAt Datetime True

The date and time when the metafield was created.

UpdatedAt Datetime True

The date and time when the metafield was last updated.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060