TDV Adapter for Shopify

Build 22.0.8462

ProductVariants

List of the product variants.

View-Specific Information

Select

The adapter uses the Shopify API to process search criteria that refer to the following columns:

  • Id
  • ProductId
  • Title
  • Barcode
  • Sku
  • Taxable
  • UpdatedAt
  • CreatedAt
  • InventoryQuantity
  • DeliveryProfileId

The adapter processes other filters client-side within the adapter. Note that server-side filter extends to =/!= for Bool/String type columns, and only includes other operators for datetime or number type columns.

For example, the following queries are processed server side: 

SELECT * FROM ProductVariants WHERE Id = 'gid://shopify/ProductVariant/6788079091735'

SELECT * FROM ProductVariants WHERE Id IN ('gid://shopify/ProductVariant/6830135181335', 'gid://ProductVariant/Product/6830135181336')

SELECT * FROM ProductVariants WHERE Title = 'title'

SELECT * FROM ProductVariants WHERE CreatedAt > '2018-02-05T15:47:32.000-05:00'

Columns

Name Type References Description
Id String A globally-unique identifier.
LegacyResourceId Long The ID of the corresponding resource in the REST Admin API.
ProductId String

Products.Id

A globally-unique identifier.
Position Int The order of the product variant in the list of product variants. The first position in the list is 1.
AvailableForSale Bool Whether the product variant is available for sale.
SellableOnlineQuantity Int The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture (limitations based on customer location).
SellingPlanGroupCount Int Count of selling plan groups associated with the product variant.
Price Decimal The price of the product variant in the default shop currency.
CompareAtPrice Decimal The compare-at price of the variant in the default shop currency.
Title String The title of the product variant.
DisplayName String Display name of the variant, based on product's title + variant's title.
Barcode String The value of the barcode associated with the product.
Weight Float The weight of the product variant in the unit system specified with weight_unit.
WeightUnit String The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: 'g', 'kg', 'oz', 'lb'.
Sku String An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
Taxable Bool Whether a tax is charged when the product variant is sold.
TaxCode String The tax code for the product variant.
UpdatedAt Datetime The date and time when the product variant was last modified.
CreatedAt Datetime The date and time when the variant was created.
InventoryPolicy String Whether customers are allowed to place an order for the product variant when it's out of stock.
InventoryQuantity Int The total sellable quantity of the variant.
InventoryItemId String A globally-unique identifier.
InventoryItemLegacyResourceId String The ID of the corresponding resource in the REST Admin API.
InventoryItemSku String Inventory item SKU.
InventoryItemDuplicateSkuCount Int The number of inventory items that share the same SKU with this item.
InventoryItemHarmonizedSystemCode String The harmonized system code of the item.
InventoryItemLocationsCount Int The number of locations where this inventory item is stocked.
InventoryItemRequiresShipping Bool Whether the inventory item requires shipping.
InventoryItemCountryCodeOfOrigin String The ISO 3166-1 alpha-2 country code of where the item originated from.
InventoryItemProvinceCodeOfOrigin String The ISO 3166-2 alpha-2 province code of where the item originated from.
InventoryItemUnitCostAmount Decimal Decimal money amount.
InventoryItemUnitCostCurrencyCode String Currency of the money.
InventoryItemTracked Bool Whether inventory levels are tracked for the item.
InventoryItemTrackedEditableLocked Bool Whether the attribute is locked for editing.
InventoryItemTrackedEditableReason String The reason the attribute is locked for editing.
InventoryItemInventoryHistoryUrl String The URL that points to the inventory history for the item.
InventoryItemCreatedAt Datetime The date and time when the inventory item was created.
InventoryItemUpdatedAt Datetime The date and time when the inventory item was updated.
ImageId String

ProductImages.Id

A unique identifier for the image.
ImageAltText String A word or phrase to share the nature or contents of an image.
ImageHeight Int The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageWidth Int The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl String The location of the image as a URL.
DeliveryProfileId String A globally-unique identifier.
DeliveryProfileName String The name of the delivery profile.
DeliveryProfileDefault Bool Whether this is the default profile.
DeliveryProfileLegacyMode Bool Whether this shop has enabled legacy compatibility mode for delivery profiles.
DeliveryProfileActiveMethodDefinitionsCount Int The number of active shipping rates for the profile.
DeliveryProfileOriginLocationCount Int The number of active origin locations for the profile.
DeliveryProfileZoneCountryCount Int The number of countries with active rates to deliver to.
DeliveryProfileLocationsWithoutRatesCount Int The number of locations without rates defined.
DeliveryProfileProductVariantsCountCount Int The product variant count.
DeliveryProfileProductVariantsCountCapped Bool Whether the count has reached the cap of 500.
FulfillmentServiceEditableLocked Bool Whether the attribute is locked for editing.
FulfillmentServiceEditableReason String The reason the attribute is locked for editing.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462