Anchor to section titled 'undefined'product
product
mutation
deprecated
2024-07
Requires write access scope. Also: The user must have a permission to create a product variant.
Creates a product variant. Use product instead.
Anchor to section titled 'Arguments'
Arguments
The properties for the new product variant.
Was this section helpful?
Anchor to section titled 'ProductVariantCreatePayload returns'
ProductVariantCreatePayload returns
The product associated with the variant.
The successfully created variant.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: productVariantCreate
Query Reference for MUTATION: productVariantCreate
"mutation productVariantCreate($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n product {\n # Product fields\n }\n productVariant {\n # ProductVariant fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: productVariantCreate
"{\n \"input\": {\n \"barcode\": \"<your-barcode>\",\n \"compareAtPrice\": \"100.57\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"inventoryItem\": {\n \"cost\": \"29.99\",\n \"countryCodeOfOrigin\": \"AC\",\n \"countryHarmonizedSystemCodes\": [\n {\n \"countryCode\": \"AC\",\n \"harmonizedSystemCode\": \"<your-harmonizedSystemCode>\"\n }\n ],\n \"harmonizedSystemCode\": \"<your-harmonizedSystemCode>\",\n \"measurement\": {\n \"weight\": {\n \"unit\": \"GRAMS\",\n \"value\": 1.1\n }\n },\n \"provinceCodeOfOrigin\": \"<your-provinceCodeOfOrigin>\",\n \"requiresShipping\": true,\n \"sku\": \"<your-sku>\",\n \"tracked\": true\n },\n \"inventoryPolicy\": \"CONTINUE\",\n \"inventoryQuantities\": [\n {\n \"availableQuantity\": 1,\n \"locationId\": \"gid://shopify/<objectName>/10079785100\"\n }\n ],\n \"mediaId\": \"gid://shopify/<objectName>/10079785100\",\n \"mediaSrc\": [\n \"<your-mediaSrc>\"\n ],\n \"metafields\": [\n {\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"key\": \"<your-key>\",\n \"namespace\": \"<your-namespace>\",\n \"type\": \"<your-type>\",\n \"value\": \"<your-value>\"\n }\n ],\n \"options\": [\n \"<your-options>\"\n ],\n \"position\": 1,\n \"price\": \"100.57\",\n \"productId\": \"gid://shopify/<objectName>/10079785100\",\n \"requiresComponents\": true,\n \"taxCode\": \"<your-taxCode>\",\n \"taxable\": true\n }\n}"Schema Reference for MUTATION: productVariantCreate
"input ProductVariantInput {\n barcode: String\n compareAtPrice: Money\n id: ID\n imageId: ID\n imageSrc: String\n inventoryItem: InventoryItemInput\n inventoryPolicy: ProductVariantInventoryPolicy\n inventoryQuantities: [InventoryLevelInput!]\n mediaId: ID\n mediaSrc: [String!]\n metafields: [MetafieldInput!]\n options: [String!]\n position: Int\n price: Money\n privateMetafields: [PrivateMetafieldInput!]\n productId: ID\n requiresComponents: Boolean\n taxCode: String\n taxable: Boolean\n title: String\n}\n\ninput InventoryItemInput {\n cost: Decimal\n countryCodeOfOrigin: CountryCode\n countryHarmonizedSystemCodes: [CountryHarmonizedSystemCodeInput!]\n harmonizedSystemCode: String\n measurement: InventoryItemMeasurementInput\n provinceCodeOfOrigin: String\n requiresShipping: Boolean\n sku: String\n tracked: Boolean\n}\n\ninput InventoryLevelInput {\n availableQuantity: Int!\n locationId: ID!\n}\n\ninput MetafieldInput {\n description: String\n id: ID\n key: String\n namespace: String\n type: String\n value: String\n}\n\ninput PrivateMetafieldInput {\n key: String!\n namespace: String!\n owner: ID\n valueInput: PrivateMetafieldValueInput!\n}\n"Display Examples for MUTATION: productVariantCreate
[
{
"example": {
"type_name": "productvariantcreate",
"title": "Create a new metafield on a new product variant",
"description": "Create a new metafield `my_field.liner_material` on a new\nproduct variant.\n\n\nAlternatively, refer to the\n[metafieldsSet](https://shopify.dev/api/admin-graphql/latest/mutations/metafieldsset) mutation\nto create and/or update metafields on product variant resources.\n",
"query_string": "mutation createProductVariantMetafields($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n productVariant {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n}",
"variables": {
"input": {
"metafields": [
{
"namespace": "my_field",
"key": "liner_material",
"type": "single_line_text_field",
"value": "Synthetic Leather"
}
],
"productId": "gid://shopify/Product/108828309"
}
},
"response": {
"data": {
"productVariantCreate": {
"productVariant": {
"id": "gid://shopify/ProductVariant/1070325086",
"metafields": {
"edges": [
{
"node": {
"id": "gid://shopify/Metafield/1069229040",
"namespace": "my_field",
"key": "liner_material",
"value": "Synthetic Leather"
}
}
]
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_variant_create_test.rb",
"minimum_api_version": null,
"maximum_api_version": null,
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation createProductVariantMetafields($input: ProductVariantInput!) { productVariantCreate(input: $input) { productVariant { id metafields(first: 3) { edges { node { id namespace key value } } } } userErrors { message field } } }\",\n \"variables\": {\n \"input\": {\n \"metafields\": [\n {\n \"namespace\": \"my_field\",\n \"key\": \"liner_material\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Synthetic Leather\"\n }\n ],\n \"productId\": \"gid://shopify/Product/108828309\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createProductVariantMetafields($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n productVariant {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"metafields\": [\n {\n \"namespace\": \"my_field\",\n \"key\": \"liner_material\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Synthetic Leather\"\n }\n ],\n \"productId\": \"gid://shopify/Product/108828309\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation createProductVariantMetafields($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n productVariant {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"metafields\": [{\"namespace\"=>\"my_field\", \"key\"=>\"liner_material\", \"type\"=>\"single_line_text_field\", \"value\"=>\"Synthetic Leather\"}],\n \"productId\": \"gid://shopify/Product/108828309\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createProductVariantMetafields($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n productVariant {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"metafields\": [\n {\n \"namespace\": \"my_field\",\n \"key\": \"liner_material\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Synthetic Leather\"\n }\n ],\n \"productId\": \"gid://shopify/Product/108828309\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createProductVariantMetafields($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n productVariant {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"metafields\" => [{\"namespace\"=>\"my_field\", \"key\"=>\"liner_material\", \"type\"=>\"single_line_text_field\", \"value\"=>\"Synthetic Leather\"}],\n \"productId\" => \"gid://shopify/Product/108828309\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The properties for the new product variant.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ProductVariantInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"metafields\":[{\"namespace\":\"my_field\",\"key\":\"liner_material\",\"type\":\"single_line_text_field\",\"value\":\"Synthetic Leather\"}],\"productId\":\"gid://shopify/Product/108828309\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productvariantcreate",
"title": "Create a new product variant with media",
"description": "Creates a new product variant associated with an existing media image object that belongs to the product.\n",
"query_string": "mutation CreateProductVariantWithMedia($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n product {\n id\n }\n productVariant {\n id\n title\n media(first: 10) {\n nodes {\n id\n alt\n mediaContentType\n preview {\n status\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}",
"query_arguments": {
"input": "$input"
},
"variables": {
"input": {
"productId": "gid://shopify/Product/108828309",
"options": [
"Yellow"
],
"mediaId": "gid://shopify/MediaImage/1041834415"
}
},
"response": {
"data": {
"productVariantCreate": {
"product": {
"id": "gid://shopify/Product/108828309"
},
"productVariant": {
"id": "gid://shopify/ProductVariant/1070325084",
"title": "Yellow",
"media": {
"nodes": [
{
"id": "gid://shopify/ExternalVideo/1041834415",
"alt": "This is a video",
"mediaContentType": "EXTERNAL_VIDEO",
"preview": {
"status": "READY"
}
}
]
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "2024-07",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_variant_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CreateProductVariantWithMedia($input: ProductVariantInput!) { productVariantCreate(input: $input) { product { id } productVariant { id title media(first: 10) { nodes { id alt mediaContentType preview { status } } } } userErrors { field message } } }\",\n \"variables\": {\n \"input\": {\n \"productId\": \"gid://shopify/Product/108828309\",\n \"options\": [\n \"Yellow\"\n ],\n \"mediaId\": \"gid://shopify/MediaImage/1041834415\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation CreateProductVariantWithMedia($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n product {\n id\n }\n productVariant {\n id\n title\n media(first: 10) {\n nodes {\n id\n alt\n mediaContentType\n preview {\n status\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"productId\": \"gid://shopify/Product/108828309\",\n \"options\": [\n \"Yellow\"\n ],\n \"mediaId\": \"gid://shopify/MediaImage/1041834415\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation CreateProductVariantWithMedia($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n product {\n id\n }\n productVariant {\n id\n title\n media(first: 10) {\n nodes {\n id\n alt\n mediaContentType\n preview {\n status\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"productId\": \"gid://shopify/Product/108828309\",\n \"options\": [\"Yellow\"],\n \"mediaId\": \"gid://shopify/MediaImage/1041834415\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation CreateProductVariantWithMedia($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n product {\n id\n }\n productVariant {\n id\n title\n media(first: 10) {\n nodes {\n id\n alt\n mediaContentType\n preview {\n status\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"productId\": \"gid://shopify/Product/108828309\",\n \"options\": [\n \"Yellow\"\n ],\n \"mediaId\": \"gid://shopify/MediaImage/1041834415\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation CreateProductVariantWithMedia($input: ProductVariantInput!) {\n productVariantCreate(input: $input) {\n product {\n id\n }\n productVariant {\n id\n title\n media(first: 10) {\n nodes {\n id\n alt\n mediaContentType\n preview {\n status\n }\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"productId\" => \"gid://shopify/Product/108828309\",\n \"options\" => [\"Yellow\"],\n \"mediaId\" => \"gid://shopify/MediaImage/1041834415\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The properties for the new product variant.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ProductVariantInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"productId\":\"gid://shopify/Product/108828309\",\"options\":[\"Yellow\"],\"mediaId\":\"gid://shopify/MediaImage/1041834415\"}",
"typeKind": "MUTATION"
}
]
}
]