GET v1/ShopifyProduct/{id}

This method gets an individual Shopify product specified by the supplied ID

Request Information

URI Parameters

Name Description Type Additional information
id

integer

Optional

Body Parameters

None.

Response Information

Resource Description

ShopifyProduct

Name Description Type
ShopifyProductID

The unique internal identifier of each Shopify rule in Tradevine e.g. 3451582911247565747468

 integer
ShopifyOrganisationID

This is the internal Tradevine ID for your Shopify account

 integer
ShopifyStoreDomain

This is the Shopify domain name for your store e.g. acme.myshopify.com

 string
ProductID

This is the internal Tradevine ID for the product that owns this Shopify rule

 integer
ProductCode

This is the code/SKU of the product to which the rule belongs. This is pushed to Shopify as SKU

 string
OrganisationID

This is the internal Tradevine ID for your Tradevine account

 integer
IsListedOnShopify

This controls whether the Tradevine product is pushed or deleted to/from Shopify

 boolean
ExternalShopifyProductID

This is the internal Shopify ID for the product that is used when Tradevine calls the Shopify API

 integer
ExternalShopifyVariantID

This is the internal Shopify ID for the variant that is used when Tradevine calls the Shopify API

 integer
IsPublished

This is used to control whether the product is visible to the outside world in your front-end shopping cart or hidden from users

 boolean
Title

This is the main title used to display for the product in Shopify e.g. World's Best T-Shirt

 string
Handle

This is used to generate the friendly URL in Shopify that your product will be available at. It is also used as the common token to bind several variant products in Tradevine into a single multi-variant product in Shopify E.g. awesome-mega-tshirt

 string
BodyHtml

This is the HTML for the body or description of your product

 string
ProductType

Used to describe the type of product e.g. Men's Clothing

 string
Vendor

Used to describe the brand or vendor of the product e.g. Adidas

 string
Tags

Space separate list of keywords that can be used when configuring smart collections in your Shopify site e.g. "mens t-shirts summer2015 onsale"

 string
SellPriceIncTax

The retail price the product should sell for on your Shopify site

 decimal number
CompareAtPrice

For Was/Now, OnSale promotions, this (higher) price will be displayed struck-out for comparison

 decimal number
AllowOverselling

This flag controls whether the product becomes unavailable for purchase when inventory is 0 (if true, the product will still be available for sale even with 0 inventory)

 boolean
CreatedDate

Date and time in UTC when the rule was created

 date
CreatedBy

Internal Tradevine ID of the user who created this rule

 integer
ModifiedDate

Date and time in UTC when the rule was last updated

 date
ModifiedBy

Internal Tradevine ID of the user who last updated this rule

 integer
PhotoIdentifier

Comma separated list of photos to display in Shopify for this product e.g. 'WidgetFront.jpg;WidgetSide.jpg;WidgetBack.jpg'

 string
OptionName1

If multi-variants are used, this is the name of the first variant set e.g. Colour

 string
OptionValue1

If multi-variant set 1 is in use, this is the name of the value of the variant for set 1 e.g. Red

 string
OptionName2

If multi-variants are used, this is the name of the second variant set e.g. Size

 string
OptionValue2

If multi-variant set 2 is in use, this is the name of the value of the variant for set 2 e.g. Small

 string
OptionName3

If multi-variants are used, this is the name of the third variant set e.g. Fabric

 string
OptionValue3

If multi-variant set 3 is in use, this is the name of the value of the variant for set 3 e.g. Cotton

 string
IsInventoryPushNeeded

boolean
VariantSortIndex

This is a simple numeric field for determining the order to show the variants in the drop-down list on your Shopify site

 integer
IsProductPushNeeded

boolean
IsArchived

boolean

Response Formats

application/json

Sample: 

{
  "ShopifyProductID": 1,
  "ShopifyOrganisationID": 1,
  "ShopifyStoreDomain": "sample string 1",
  "ProductID": 1,
  "ProductCode": "sample string 2",
  "OrganisationID": 1,
  "IsListedOnShopify": true,
  "ExternalShopifyProductID": 1,
  "ExternalShopifyVariantID": 1,
  "IsPublished": true,
  "Title": "sample string 3",
  "Handle": "sample string 4",
  "BodyHtml": "sample string 5",
  "ProductType": "sample string 6",
  "Vendor": "sample string 7",
  "Tags": "sample string 8",
  "SellPriceIncTax": 1.0,
  "CompareAtPrice": 1.0,
  "AllowOverselling": true,
  "CreatedDate": "2024-04-23T22:49:28.2714784+12:00",
  "CreatedBy": 1,
  "ModifiedDate": "2024-04-23T22:49:28.2714784+12:00",
  "ModifiedBy": 1,
  "PhotoIdentifier": "sample string 9",
  "OptionName1": "sample string 10",
  "OptionValue1": "sample string 11",
  "OptionName2": "sample string 12",
  "OptionValue2": "sample string 13",
  "OptionName3": "sample string 14",
  "OptionValue3": "sample string 15",
  "IsInventoryPushNeeded": true,
  "VariantSortIndex": 1,
  "IsProductPushNeeded": true,
  "IsArchived": true
}