Shopify - Product mapping
- lkj
The table below lists all the possible mappings supported via the Shopify Connector. For a more detailed description for each field see the Shopify GraphQL API documentation.
Mapping to field | Output Kind | Description |
|---|---|---|
SyncID (Required) | Field | The SyncID will be updated with Shopify Id for the product. NOTE: if more than one channel is used, then this parameter must be independent for each channel. |
SyncDate (Required) | Field | The SyncDate will be updated with Shopify “Updated At” for the product. NOTE: deleting SyncDate value for chosen product will lead to product update in Shopify on next synchronization. NOTE: if more than one channel is used, then this parameter must be independent for each channel. |
Key = @Id (Required) | KeyField | A KeyField mapping From “@Id” To “Key” is required. |
Title (Required) | Field | The title of the product. The Title is translatable. |
SyncMsg | Field | SyncMsg will be used for reporting errors back to products in Perfion. |
Collections | RelatedCategory | This is a special parameter, which allows to specify the link from Perfion product to Perfion category, which will be converted to the link from Shopify product to Shopify custom collection by using Shopify collects. |
Options | VariantDimension | The value is a comma separated list of feature names (unique feature name should be used), which define product variant options. |
Category | Field | The Id of the node in the Shopify product taxonomy that represents the product category. E.g. “el-1-1” for “Basketball Arcade Games → Arcade Equipment → Electronics”. Find the Id in Shopify Taxonomy Explorer (From version 2.1.0.). |
CustomProductType | Field | The custom product type specified by the merchant. Deprecated from version 2.1.0. Use the ProductType field instead |
BodyHtml | Field | A productdescription in plain test or Html. The BodyHtml is translatable. |
GiftCard | Field | A boolean true/false to determine whether the product is a gift card. |
GiftCardTemplateSuffix | Field | The theme template used when viewing the gift card in a store. |
Handle | Field | A unique, human-friendly string for the product. Automatically generated from the product's title unless otherwise specified. The Handle is translatable. |
Image | Image(Url) | An image stored in Perfion (Required the Perfion API is publicly available). The Image will be the thumbnail image (If an Image with output kind Field is mapped, the Field mapping will be the thumbnail). |
Images | Image(Url) | Images stored in Perfion (Required the Perfion API is publicly available). |
Images(<ImageFeature>)@AltText | Attribute | For Images via Image(Url) it is possible to include an attribute “AltTest” for adding an Alternative text to the image. See Outputting Multi Value-attributes for more information's about attributes on multi values. |
Image | Field | An image url. Must be a fully qualified URL path, including protocol. The Image will be the thumbnail image. |
Images | Field | Image url's. Must be a fully qualified URL path, including protocol. |
Markets | Field | A Multi feature or a comma separated list of Market names the product should be published at. |
ProductCategory | Field | The ID of the node in the Shopify taxonomy that represents the product category. E.g. “gid://shopify/TaxonomyCategory/ap”. Deprecated from version 2.1.0. Use the category field instead. |
ProductType | Field | The product type specified by the merchant. The ProductType is translatable. |
RedirectNewHandle | Field | A boolean true/false to determine wehether a redirect is required after a new handle has been provided. If true, then the old handle is redirected to the new one automatically. |
Requiressellingplan | Field | A boolean true/false to determine whether the product can only be purchased with a selling plan (subscription). Products that are sold exclusively on subscription can only be created on online stores. If set to true on an already existing product, then the product will be marked unavailable on channels that don't support subscriptions. |
SalesChannels | Field | A Multi feature or a comma separated list of Sales Channel names the product should be published at. |
SeoDescription | Field | SEO description of the product. |
SeoTitle | Field | SEO title of the product. |
StandardizedProductType | Field | The ID of the node in the Shopify taxonomy that represents the product type. Deprecated from version 2.1.0. Use the category field instead. |
Status | Field | The status of the product. Allowed values:
|
Tags | Field | A Multi feature or a comma separated list of tags that have been added to the product. |
TemplateSuffix | Field | The theme template used when viewing the product in a store. |
Vendor | Field | The name of the product's vendor. |
Metafield|<namespace>|<key>|<type> | Field | See Shopify - Metafield Mapping for more information. |
Extra mapping for products without variants
Mapping to field | Output Kind | Description |
|---|---|---|
Barcode | Field | The value of the barcode associated with the product. |
CompareAtPrice | Field | The compare-at price of the product. |
CountryCodeOfOrigin | Field | The country code of where the item originated from. |
InventoryPolicy | Field | Whether customers are allowed to place an order for the product when it's out of stock. Allowed values:
|
Cost | Field | Unit cost associated with the inventory item, the currency is the shop's default currency. |
Price | Field | The price of the product. |
HarmonizedSystemCode | Field | The harmonized system code of the inventory item. |
RequiresComponents | Field | A boolean true/false to determine whether the product requires components. The default value is false. If true, then the product can only be purchased as a parent bundle with components and it will be omitted from channels that don't support bundles. |
RequiresShipping | Field | A boolean true/false to determine whether the product requires shipping |
Sku | Field | The SKU for the product. Case-sensitive string. |
TaxCode | Field | The tax code associated with the product. |
Taxable | Field | A boolean true/false to determine whether the product is taxable. |
Tracked | Field | A boolean true/false to determine whether the inventory quantities is tracked. |
Weight | Field | The weight of the product. |
WeightUnit | Field | The weight unit of the product. Allowed values:
|
Quantity_<location1> | Field | The inventory quantity at the location where the product is stocked like Quantity_RefLoc_<label>. |