Shopify Product Variant
This page documents the Shopify Product Variant model.
Data Shape
Gadget's database stores Shopify Product Variant records by storing and retrieving each of the fields defined on the model in the Gadget Editor to a managed database. Gadget has generated a GraphQL type matching the configured fields for Shopify Product Variant:
1export interface ShopifyProductVariant {2 __typename: "ShopifyProductVariant";34 /** The globally unique, unchanging identifier for this record. Assigned and managed by Gadget. */5 id: Scalars["GadgetID"];67 /** The time at which this record was first created. Set once upon record creation and never changed. Managed by Gadget. */8 createdAt: Scalars["DateTime"];910 /** The time at which this record was last changed. Set each time the record is successfully acted upon by an action. Managed by Gadget. */11 updatedAt: Scalars["DateTime"];1213 /** The current state this record is in. Changed by invoking actions. Managed by Gadget. */14 state: Scalars["RecordState"];1516 barcode: Scalars["String"] | null;1718 compareAtPrice: Scalars["String"] | null;1920 fulfillmentService: Scalars["String"] | null;2122 grams: Scalars["Float"] | null;2324 inventoryManagement: Scalars["String"] | null;2526 inventoryPolicy: Scalars["String"] | null;2728 productImage: ShopifyProductImage | null;2930 productImageId: Scalars["GadgetID"] | null;3132 inventoryQuantity: Scalars["Float"] | null;3334 inventoryQuantityAdjustment: Scalars["Float"] | null;3536 oldInventoryQuantity: Scalars["Float"] | null;3738 option1: Scalars["String"] | null;3940 option2: Scalars["String"] | null;4142 option3: Scalars["String"] | null;4344 position: Scalars["Float"] | null;4546 presentmentPrices: Scalars["JSON"] | null;4748 price: Scalars["String"] | null;4950 requiresShipping: Scalars["Boolean"] | null;5152 product: ShopifyProduct | null;5354 productId: Scalars["GadgetID"] | null;5556 shopifyCreatedAt: Scalars["DateTime"] | null;5758 sku: Scalars["String"] | null;5960 taxCode: Scalars["String"] | null;6162 shopifyUpdatedAt: Scalars["DateTime"] | null;6364 taxable: Scalars["Boolean"] | null;6566 title: Scalars["String"] | null;6768 weight: Scalars["Float"] | null;6970 weightUnit: Scalars["String"] | null;7172 shop: ShopifyShop | null;7374 shopId: Scalars["GadgetID"] | null;7576 results: ResultConnection;7778 /** Get all the fields for this record. Useful for not having to list out all the fields you want to retrieve, but slower. */79 _all: Scalars["JSONObject"];80}
1type ShopifyProductVariant {2 """3 The globally unique, unchanging identifier for this record. Assigned and managed by Gadget.4 """5 id: GadgetID!67 """8 The time at which this record was first created. Set once upon record creation and never changed. Managed by Gadget.9 """10 createdAt: DateTime!1112 """13 The time at which this record was last changed. Set each time the record is successfully acted upon by an action. Managed by Gadget.14 """15 updatedAt: DateTime!1617 """18 The current state this record is in. Changed by invoking actions. Managed by Gadget.19 """20 state: RecordState!21 barcode: String22 compareAtPrice: String23 fulfillmentService: String24 grams: Float25 inventoryManagement: String26 inventoryPolicy: String27 productImage: ShopifyProductImage28 productImageId: GadgetID29 inventoryQuantity: Float30 inventoryQuantityAdjustment: Float31 oldInventoryQuantity: Float32 option1: String33 option2: String34 option3: String35 position: Float36 presentmentPrices: JSON37 price: String38 requiresShipping: Boolean39 product: ShopifyProduct40 productId: GadgetID41 shopifyCreatedAt: DateTime42 sku: String43 taxCode: String44 shopifyUpdatedAt: DateTime45 taxable: Boolean46 title: String47 weight: Float48 weightUnit: String49 shop: ShopifyShop50 shopId: GadgetID51 results(52 """53 Returns the items in the list that come after the specified cursor.54 """55 after: String5657 """58 Returns the first n items from the list.59 """60 first: Int6162 """63 Returns the items in the list that come before the specified cursor.64 """65 before: String6667 """68 Returns the last n items from the list.69 """70 last: Int7172 """73 A list of sort orders to return the results in74 """75 sort: [ResultSort!]7677 """78 A list of filters to refine the results by79 """80 filter: [ResultFilter!]8182 """83 A free form text search query to find records matching84 """85 search: String86 ): ResultConnection!8788 """89 Get all the fields for this record. Useful for not having to list out all the fields you want to retrieve, but slower.90 """91 _all: JSONObject!92}
You can preview what a real record's shape looks like by fetching it using the alida-quiz-app-2 API Playground.
Any fetched Shopify Product Variant record will have this same ShopifyProductVariant type, and expose the same data by default, regardless of if it's fetched by ID or as part of a findMany. This means you can select any of the record's fields wherever you like in a GraphQL query according to the use case at hand.
Retrieving one Shopify Product Variant record
Individual Shopify Product Variant records can be retrieved using the "find by ID" API endpoint. You can also return only some fields, or
extra fields beyond what Gadget retrieves by default, using the select option.
The findOne function throws an error if no matching record is found, which you will need to catch and handle. Alternatively, you can use
the maybeFindOne function, which returns null if no record is found, without throwing an error.
Similarly, the useFindOne React hook returns (but does not throw) an error when no matching record is found, while the useMaybeFindOne hook simply returns null if no record is found, without also returning an error.
const shopifyProductVariantRecord = await api.shopifyProductVariant.findOne("some-id");console.log(shopifyProductVariantRecord.id); //=> a stringconsole.log(shopifyProductVariantRecord.createdAt); //=> a Date object
const [result, refresh] = useFindOne(api.shopifyProductVariant, "some-id");const { data, error, fetching } = result;console.log(data?.id); //=> a stringconsole.log(data?.createdAt); //=> a Date object
1query GetOneShopifyProductVariant($id: GadgetID!) {2 shopifyProductVariant(id: $id) {3 __typename4 id5 state6 barcode7 compareAtPrice8 createdAt9 fulfillmentService10 grams11 inventoryManagement12 inventoryPolicy13 inventoryQuantity14 inventoryQuantityAdjustment15 oldInventoryQuantity16 option117 option218 option319 position20 presentmentPrices21 price22 product {23 id24 state25 body26 createdAt27 handle28 productType29 publishedAt30 publishedScope31 shop {32 id33 state34 accessToken35 address136 address237 checkoutApiSupported38 city39 cookieConsentLevel40 country41 countryCode42 countryName43 countyTaxes44 createdAt45 currency46 customerEmail47 domain48 eligibleForCardReaderGiveaway49 eligibleForPayments50 email51 enabledPresentmentCurrencies52 finances53 forceSsl54 googleAppsDomain55 googleAppsLoginEnabled56 grantedScopes57 hasDiscounts58 hasGiftCards59 hasStorefront60 ianaTimezone61 installedViaApiKey62 latitude63 longitude64 moneyFormat65 moneyInEmailsFormat66 moneyWithCurrencyFormat67 moneyWithCurrencyInEmailsFormat68 multiLocationEnabled69 myshopifyDomain70 name71 passwordEnabled72 phone73 planDisplayName74 planName75 preLaunchEnabled76 primaryLocale77 province78 provinceCode79 registeredWebhooks80 requiresExtraPaymentsAgreement81 setupRequired82 shopOwner83 shopifyCreatedAt84 shopifyUpdatedAt85 source86 taxShipping87 taxesIncluded88 timezone89 updatedAt90 weightUnit91 zipCode92 }93 shopifyCreatedAt94 shopifyUpdatedAt95 tags96 templateSuffix97 title98 updatedAt99 vendor100 }101 productImage {102 id103 state104 createdAt105 height106 position107 product {108 id109 state110 body111 createdAt112 handle113 productType114 publishedAt115 publishedScope116 shopifyCreatedAt117 shopifyUpdatedAt118 tags119 templateSuffix120 title121 updatedAt122 vendor123 }124 shop {125 id126 state127 accessToken128 address1129 address2130 checkoutApiSupported131 city132 cookieConsentLevel133 country134 countryCode135 countryName136 countyTaxes137 createdAt138 currency139 customerEmail140 domain141 eligibleForCardReaderGiveaway142 eligibleForPayments143 email144 enabledPresentmentCurrencies145 finances146 forceSsl147 googleAppsDomain148 googleAppsLoginEnabled149 grantedScopes150 hasDiscounts151 hasGiftCards152 hasStorefront153 ianaTimezone154 installedViaApiKey155 latitude156 longitude157 moneyFormat158 moneyInEmailsFormat159 moneyWithCurrencyFormat160 moneyWithCurrencyInEmailsFormat161 multiLocationEnabled162 myshopifyDomain163 name164 passwordEnabled165 phone166 planDisplayName167 planName168 preLaunchEnabled169 primaryLocale170 province171 provinceCode172 registeredWebhooks173 requiresExtraPaymentsAgreement174 setupRequired175 shopOwner176 shopifyCreatedAt177 shopifyUpdatedAt178 source179 taxShipping180 taxesIncluded181 timezone182 updatedAt183 weightUnit184 zipCode185 }186 shopifyCreatedAt187 shopifyUpdatedAt188 source189 updatedAt190 width191 }192 requiresShipping193 results {194 edges {195 node {196 id197 state198 body199 createdAt200 imageUrl201 productSuggestion {202 id203 state204 barcode205 compareAtPrice206 createdAt207 fulfillmentService208 grams209 inventoryManagement210 inventoryPolicy211 inventoryQuantity212 inventoryQuantityAdjustment213 oldInventoryQuantity214 option1215 option2216 option3217 position218 presentmentPrices219 price220 requiresShipping221 shopifyCreatedAt222 shopifyUpdatedAt223 sku224 taxCode225 taxable226 title227 updatedAt228 weight229 weightUnit230 }231 quiz {232 id233 state234 body235 createdAt236 title237 updatedAt238 }239 updatedAt240 }241 }242 }243 shop {244 id245 state246 accessToken247 address1248 address2249 checkoutApiSupported250 city251 cookieConsentLevel252 country253 countryCode254 countryName255 countyTaxes256 createdAt257 currency258 customerEmail259 domain260 eligibleForCardReaderGiveaway261 eligibleForPayments262 email263 enabledPresentmentCurrencies264 finances265 forceSsl266 googleAppsDomain267 googleAppsLoginEnabled268 grantedScopes269 hasDiscounts270 hasGiftCards271 hasStorefront272 ianaTimezone273 installedViaApiKey274 latitude275 longitude276 moneyFormat277 moneyInEmailsFormat278 moneyWithCurrencyFormat279 moneyWithCurrencyInEmailsFormat280 multiLocationEnabled281 myshopifyDomain282 name283 passwordEnabled284 phone285 planDisplayName286 planName287 preLaunchEnabled288 primaryLocale289 province290 provinceCode291 registeredWebhooks292 requiresExtraPaymentsAgreement293 setupRequired294 shopOwner295 shopifyCreatedAt296 shopifyUpdatedAt297 source298 taxShipping299 taxesIncluded300 timezone301 updatedAt302 weightUnit303 zipCode304 }305 shopifyCreatedAt306 shopifyUpdatedAt307 sku308 taxCode309 taxable310 title311 updatedAt312 weight313 weightUnit314 }315}
{"id": "some-id"}
Retrieving the first of many Shopify Product Variant records
The first record from a list of records can be retrieved using the "find first" API endpoint. The source list of records can be filtered using the filter option, sorted using the sort option, searched using the search option, though no pagination options are available on this endpoint. You can also return only some fields, or extra fields beyond what Gadget retrieves by default using the select option.
The findFirst function throws an error if no matching record is found, which you will need to catch and handle. Alternatively, you can use
the maybeFindFirst function, which returns null if no record is found, without throwing an error.
Similarly, the useFindFirst React hook returns (but does not throw) an error when no matching record is found, while the useMaybeFindFirst hook simply returns null if no record is found, without also returning an error.
const shopifyProductVariantRecord = await api.shopifyProductVariant.findFirst();console.log(shopifyProductVariantRecord.id); //=> a stringconsole.log(shopifyProductVariantRecord.createdAt); //=> a Date object
const [result, refresh] = useFindFirst(api.shopifyProductVariant);const { data, error, fetching } = result;console.log(data?.id); //=> a stringconsole.log(data?.createdAt); //=> a Date object
1query FindManyShopifyProductVariants(2 $first: Int3 $search: String4 $sort: [ShopifyProductVariantSort!]5 $filter: [ShopifyProductVariantFilter!]6) {7 shopifyProductVariants(8 first: $first9 search: $search10 sort: $sort11 filter: $filter12 ) {13 edges {14 node {15 __typename16 id17 state18 barcode19 compareAtPrice20 createdAt21 fulfillmentService22 grams23 inventoryManagement24 inventoryPolicy25 inventoryQuantity26 inventoryQuantityAdjustment27 oldInventoryQuantity28 option129 option230 option331 position32 presentmentPrices33 price34 product {35 id36 state37 body38 createdAt39 handle40 productType41 publishedAt42 publishedScope43 shop {44 id45 state46 accessToken47 address148 address249 checkoutApiSupported50 city51 cookieConsentLevel52 country53 countryCode54 countryName55 countyTaxes56 createdAt57 currency58 customerEmail59 domain60 eligibleForCardReaderGiveaway61 eligibleForPayments62 email63 enabledPresentmentCurrencies64 finances65 forceSsl66 googleAppsDomain67 googleAppsLoginEnabled68 grantedScopes69 hasDiscounts70 hasGiftCards71 hasStorefront72 ianaTimezone73 installedViaApiKey74 latitude75 longitude76 moneyFormat77 moneyInEmailsFormat78 moneyWithCurrencyFormat79 moneyWithCurrencyInEmailsFormat80 multiLocationEnabled81 myshopifyDomain82 name83 passwordEnabled84 phone85 planDisplayName86 planName87 preLaunchEnabled88 primaryLocale89 province90 provinceCode91 registeredWebhooks92 requiresExtraPaymentsAgreement93 setupRequired94 shopOwner95 shopifyCreatedAt96 shopifyUpdatedAt97 source98 taxShipping99 taxesIncluded100 timezone101 updatedAt102 weightUnit103 zipCode104 }105 shopifyCreatedAt106 shopifyUpdatedAt107 tags108 templateSuffix109 title110 updatedAt111 vendor112 }113 productImage {114 id115 state116 createdAt117 height118 position119 product {120 id121 state122 body123 createdAt124 handle125 productType126 publishedAt127 publishedScope128 shopifyCreatedAt129 shopifyUpdatedAt130 tags131 templateSuffix132 title133 updatedAt134 vendor135 }136 shop {137 id138 state139 accessToken140 address1141 address2142 checkoutApiSupported143 city144 cookieConsentLevel145 country146 countryCode147 countryName148 countyTaxes149 createdAt150 currency151 customerEmail152 domain153 eligibleForCardReaderGiveaway154 eligibleForPayments155 email156 enabledPresentmentCurrencies157 finances158 forceSsl159 googleAppsDomain160 googleAppsLoginEnabled161 grantedScopes162 hasDiscounts163 hasGiftCards164 hasStorefront165 ianaTimezone166 installedViaApiKey167 latitude168 longitude169 moneyFormat170 moneyInEmailsFormat171 moneyWithCurrencyFormat172 moneyWithCurrencyInEmailsFormat173 multiLocationEnabled174 myshopifyDomain175 name176 passwordEnabled177 phone178 planDisplayName179 planName180 preLaunchEnabled181 primaryLocale182 province183 provinceCode184 registeredWebhooks185 requiresExtraPaymentsAgreement186 setupRequired187 shopOwner188 shopifyCreatedAt189 shopifyUpdatedAt190 source191 taxShipping192 taxesIncluded193 timezone194 updatedAt195 weightUnit196 zipCode197 }198 shopifyCreatedAt199 shopifyUpdatedAt200 source201 updatedAt202 width203 }204 requiresShipping205 results {206 edges {207 node {208 id209 state210 body211 createdAt212 imageUrl213 productSuggestion {214 id215 state216 barcode217 compareAtPrice218 createdAt219 fulfillmentService220 grams221 inventoryManagement222 inventoryPolicy223 inventoryQuantity224 inventoryQuantityAdjustment225 oldInventoryQuantity226 option1227 option2228 option3229 position230 presentmentPrices231 price232 requiresShipping233 shopifyCreatedAt234 shopifyUpdatedAt235 sku236 taxCode237 taxable238 title239 updatedAt240 weight241 weightUnit242 }243 quiz {244 id245 state246 body247 createdAt248 title249 updatedAt250 }251 updatedAt252 }253 }254 }255 shop {256 id257 state258 accessToken259 address1260 address2261 checkoutApiSupported262 city263 cookieConsentLevel264 country265 countryCode266 countryName267 countyTaxes268 createdAt269 currency270 customerEmail271 domain272 eligibleForCardReaderGiveaway273 eligibleForPayments274 email275 enabledPresentmentCurrencies276 finances277 forceSsl278 googleAppsDomain279 googleAppsLoginEnabled280 grantedScopes281 hasDiscounts282 hasGiftCards283 hasStorefront284 ianaTimezone285 installedViaApiKey286 latitude287 longitude288 moneyFormat289 moneyInEmailsFormat290 moneyWithCurrencyFormat291 moneyWithCurrencyInEmailsFormat292 multiLocationEnabled293 myshopifyDomain294 name295 passwordEnabled296 phone297 planDisplayName298 planName299 preLaunchEnabled300 primaryLocale301 province302 provinceCode303 registeredWebhooks304 requiresExtraPaymentsAgreement305 setupRequired306 shopOwner307 shopifyCreatedAt308 shopifyUpdatedAt309 source310 taxShipping311 taxesIncluded312 timezone313 updatedAt314 weightUnit315 zipCode316 }317 shopifyCreatedAt318 shopifyUpdatedAt319 sku320 taxCode321 taxable322 title323 updatedAt324 weight325 weightUnit326 }327 }328 }329}
{"first": 1}
Retrieving many Shopify Product Variant records
Pages of Shopify Product Variant records can be retrieved by using the "find many" API endpoint. The returned records can be filtered using the filter option, sorted using the sort option, searched using the search option, and paginated using standard Relay-style pagination options. You can also return only some fields, or extra fields beyond what Gadget retrieves by default using the select option.
This GraphQL endpoint returns records in the Relay Connection style (as a list of edges with nodes and cursors) so they can be paginated. The shopifyProductVariants GraphQL endpoint works with any Relay-compatible caching client, or you can use Gadget's JS client for pagination with the findMany function.
Find a page of Shopify Product Variants
Fetch a page of records with the shopifyProductVariant.findMany JS method or the shopifyProductVariants GraphQL field. No options are required. The records returned will be implicitly sorted by ID ascending.
const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany();console.log(shopifyProductVariantRecords.length); //=> a numberconsole.log(shopifyProductVariantRecords[0].id); //=> a string
const [result, refresh] = useFindMany(api.shopifyProductVariant);const { data, error, fetching } = result;console.log(data?.length); //=> a numberconsole.log(data?.[0].length); //=> a string
1query FindManyShopifyProductVariants {2 shopifyProductVariants {3 edges {4 node {5 __typename6 id7 state8 # ...9 createdAt10 updatedAt11 }12 }13 }14}
{}
Sorting
Records can be sorted in the database to retrieve them in a certain order. Records are always implicitly sorted by ID ascending unless an explicit sort on the id field is defined. The GraphQL type ShopifyProductVariantSort defines which fields can be sorted by.
Records can be sorted by multiple different fields and in multiple different directions by passing a list of ShopifyProductVariantSort instead of just one.
1input ShopifyProductVariantSort {2 id: SortOrder3 createdAt: SortOrder4 updatedAt: SortOrder5 state: SortOrder6 barcode: SortOrder7 compareAtPrice: SortOrder8 fulfillmentService: SortOrder9 grams: SortOrder10 inventoryManagement: SortOrder11 inventoryPolicy: SortOrder12 inventoryQuantity: SortOrder13 inventoryQuantityAdjustment: SortOrder14 oldInventoryQuantity: SortOrder15 option1: SortOrder16 option2: SortOrder17 option3: SortOrder18 position: SortOrder19 presentmentPrices: SortOrder20 price: SortOrder21 requiresShipping: SortOrder22 shopifyCreatedAt: SortOrder23 sku: SortOrder24 taxCode: SortOrder25 shopifyUpdatedAt: SortOrder26 taxable: SortOrder27 title: SortOrder28 weight: SortOrder29 weightUnit: SortOrder30}
Pass the sort option to the JS client, or the sort variable to a GraphQL query to sort the records returned.
const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({sort: { createdAt: "Descending" },});
const [result, refresh] = useFindMany(api.shopifyProductVariant, {sort: { createdAt: "Descending" },});const { data, error, fetching } = result;
1query FindManyShopifyProductVariants($sort: [ShopifyProductVariantSort!]) {2 shopifyProductVariants(sort: $sort) {3 edges {4 node {5 __typename6 id7 state8 # ...9 createdAt10 updatedAt11 }12 }13 }14}
{"sort": {"createdAt": "Descending"}}
Sort by multiple fields by passing an array of { [field]: "Ascending" | "Descending" } objects.
const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({sort: [{ state: "Descending" }, { createdAt: "Ascending" }],});
const [result, refresh] = useFindMany(api.shopifyProductVariant, {sort: [{ state: "Descending" }, { createdAt: "Ascending" }],});const { data, error, fetching } = result;
1query FindManyShopifyProductVariants($sort: [ShopifyProductVariantSort!]) {2 shopifyProductVariants(sort: $sort) {3 edges {4 node {5 __typename6 id7 state8 # ...9 createdAt10 updatedAt11 }12 }13 }14}
1{2 "sort": [3 {4 "state": "Descending"5 },6 {7 "createdAt": "Ascending"8 }9 ]10}
All primitive field types in Gadget are sortable so you are able to sort by fields you have added to a model as well.
const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({sort: { id: "Descending" },});
const [result, refresh] = useFindMany(api.shopifyProductVariant, {sort: { id: "Descending" },});const { data, error, fetching } = result;
1query FindManyShopifyProductVariants($sort: [ShopifyProductVariantSort!]) {2 shopifyProductVariants(sort: $sort) {3 edges {4 node {5 __typename6 id7 state8 # ...9 createdAt10 updatedAt11 }12 }13 }14}
{"sort": {"id": "Descending"}}
Searching
Shopify Product Variant records can be searched using Gadget's built in full text search functionality. Gadget search is appropriate for powering
autocompletes, searchable tables, or other experiences where humans are writing search queries. It's typo tolerant, synonym aware and supports
simple search operators like ! to exclude search terms.
Search Shopify Product Variants by passing the search parameter with a search query string.
Search isn't field specific in Gadget -- all String or RichText field types are searched with the built in search functionality.
const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({search: "a specific phrase to search for",});
const [result, refresh] = useFindMany(api.shopifyProductVariant, {search: "a specific phrase to search for",});const { data, error, fetching } = result;
1query FindManyShopifyProductVariants($search: String) {2 shopifyProductVariants(search: $search) {3 edges {4 node {5 __typename6 id7 state8 # ...9 createdAt10 updatedAt11 }12 }13 }14}
{"search": "a specific phrase to search for"}
Filtering
Shopify Product Variant records can be filtered to return only the appropriate records. Records can be filtered on any field, including those managed by Gadget or fields added by developers. Filters can be combined with sorts, searches and paginated using cursor based Relay pagination.
Filter Shopify Product Variants by passing the filter parameter with a filter object. Filter objects are nestable boolean conditions expressed as JS objects capturing a key, an operator, and usually a value.
The GraphQL type ShopifyProductVariantFilter defines which fields can be filtered on.
Records can be filtered by multiple different fields. If you want to combine filters using boolean logic, nest them under the AND, OR, or NOT keys of a parent filter. Filters can be nested deeply by passing multiple levels boolean condition filters.
You can also pass a list of filters to the filter parameter which will be implicitly ANDed with one another such that they all need to match for a record to be returned.
1input ShopifyProductVariantFilter {2 AND: [ShopifyProductVariantFilter]3 OR: [ShopifyProductVariantFilter]4 NOT: [ShopifyProductVariantFilter]5 id: IDFilter6 createdAt: DateTimeFilter7 updatedAt: DateTimeFilter8 state: StateFilter9 barcode: StringFilter10 compareAtPrice: StringFilter11 fulfillmentService: StringFilter12 grams: FloatFilter13 inventoryManagement: StringFilter14 inventoryPolicy: StringFilter15 productImage: IDFilter16 inventoryQuantity: FloatFilter17 inventoryQuantityAdjustment: FloatFilter18 oldInventoryQuantity: FloatFilter19 option1: StringFilter20 option2: StringFilter21 option3: StringFilter22 position: FloatFilter23 presentmentPrices: AnyFilter24 price: StringFilter25 requiresShipping: BooleanFilter26 product: IDFilter27 shopifyCreatedAt: DateTimeFilter28 sku: StringFilter29 taxCode: StringFilter30 shopifyUpdatedAt: DateTimeFilter31 taxable: BooleanFilter32 title: StringFilter33 weight: FloatFilter34 weightUnit: StringFilter35 shop: IDFilter36}
const yesterday = new Date(Date.now() - 864e5);const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({filter: { createdAt: { greaterThan: yesterday } },});
const yesterday = new Date(Date.now() - 864e5);const [result, refresh] = useFindMany(api.shopifyProductVariant, {filter: { createdAt: { greaterThan: yesterday } },});const { data, error, fetching } = result;
1query FindManyShopifyProductVariants($filter: [ShopifyProductVariantFilter!]) {2 shopifyProductVariants(filter: $filter) {3 edges {4 node {5 __typename6 id7 state8 # ...9 createdAt10 updatedAt11 }12 }13 }14}
1{2 "filter": {3 "createdAt": {4 "greaterThan": "2022-10-03T07:40:52.498Z"5 }6 }7}
1const yesterday = new Date(Date.now() - 86400000);2const oneWeekAgo = new Date(Date.now() - 604800000);3const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({4 filter: {5 OR: [6 {7 createdAt: { greaterThan: oneWeekAgo },8 },9 {10 updated: { greaterThan: yesterday },11 },12 ],13 },14});
1const yesterday = new Date(Date.now() - 86400000);2const oneWeekAgo = new Date(Date.now() - 604800000);3const [result, refresh] = useFindMany(api.shopifyProductVariant, {4 filter: {5 OR: [6 {7 createdAt: { greaterThan: oneWeekAgo },8 },9 {10 updated: { greaterThan: yesterday },11 },12 ],13 },14});15const { data, error, fetching } = result;
1query FindManyShopifyProductVariants($filter: [ShopifyProductVariantFilter!]) {2 shopifyProductVariants(filter: $filter) {3 edges {4 node {5 __typename6 id7 state8 # ...9 createdAt10 updatedAt11 }12 }13 }14}
1{2 "filter": {3 "OR": [4 {5 "createdAt": {6 "greaterThan": "2022-09-27T07:40:52.498Z"7 }8 },9 {10 "updated": {11 "greaterThan": "2022-10-03T07:40:52.498Z"12 }13 }14 ]15 }16}
Filter records that are in the created state
const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({filter: {state: { inState: "created" },},});
1const [result, refresh] = useFindMany(api.shopifyProductVariant, {2 filter: {3 state: { inState: "created" },4 },5});6const { data, error, fetching } = result;
1query FindManyShopifyProductVariants($filter: [ShopifyProductVariantFilter!]) {2 shopifyProductVariants(filter: $filter) {3 edges {4 node {5 __typename6 id7 state8 # ...9 createdAt10 updatedAt11 }12 }13 }14}
1{2 "filter": {3 "state": {4 "inState": "created"5 }6 }7}
Most field types in Gadget are filterable, so you are able to filter by fields you have added to a model as well.
const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({filter: {id: { isSet: true },},});
1const [result, refresh] = useFindMany(api.shopifyProductVariant, {2 filter: {3 id: { isSet: true },4 },5});6const { data, error, fetching } = result;
1query FindManyShopifyProductVariants($filter: [ShopifyProductVariantFilter!]) {2 shopifyProductVariants(filter: $filter) {3 edges {4 node {5 __typename6 id7 state8 # ...9 createdAt10 updatedAt11 }12 }13 }14}
1{2 "filter": {3 "id": {4 "isSet": true5 }6 }7}
Pagination
All Gadget record lists, including the top level Shopify Product Variant finder as well as associations to Shopify Product Variant, are structured as GraphQL connections. GraphQL connections are the defacto standard for querying lists and support cursor based forward and backward pagination. When querying via GraphQL, you must select the edges field and then the node field to get the Shopify Product Variant record. When querying using a Gadget API client, the GraphQL queries are generated for you and the records are unwrapped and returned as a GadgetRecordList ready for use.
Shopify Product Variant pagination supports the standard GraphQL connection pagination arguments: first + after, or last + before. Pagination
is done using cursors, which you can retrieve from the edge.cursor field or the pageInfo.startCursor properties.
const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({first: 25,});console.log(shopifyProductVariantRecords.length); //=> no greater than 25
const [result, refresh] = useFindMany(api.shopifyProductVariant, { first: 25 });const { data, error, fetching } = result;console.log(data?.length); //=> no greater than 25
1query FindManyShopifyProductVariants($first: Int, $after: String) {2 shopifyProductVariants(first: $first, after: $after) {3 edges {4 cursor5 node {6 __typename7 id8 state9 # ...10 createdAt11 updatedAt12 }13 }14 pageInfo {15 endCursor16 hasNextPage17 hasPreviousPage18 startCursor19 }20 }21}
{"first": 25}
The after cursor used in this example data won't return any records if used in a real API request.
const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({after: "abcdefg",first: 25,});
const [result, refresh] = useFindMany(api.shopifyProductVariant, {after: "abcdefg",first: 25,});const { data, error, fetching } = result;
1query FindManyShopifyProductVariants($first: Int, $after: String) {2 shopifyProductVariants(first: $first, after: $after) {3 edges {4 cursor5 node {6 __typename7 id8 state9 # ...10 createdAt11 updatedAt12 }13 }14 pageInfo {15 endCursor16 hasNextPage17 hasPreviousPage18 startCursor19 }20 }21}
{"first": 25,"after": "abcdefg"}
Pagination Limits
Root level record finders like shopifyProductVariants support a maximum page size of 250 records, and a default page size of 50 records. The page size is controlled using the first or last GraphQL field arguments.
Related record finders that access lists of records through a HasMany or HasManyThrough field support a maximum page size of 100 records, and a default page size of 50 records.
Get the next or previous page
When using the generated JavaScript API client, the record lists returned from find many calls can be paginated using the nextPage() or previousPage() option.
Both nextPage() and previousPage() will throw an error if the corresponding hasNextPage or hasPreviousPage is false.
1const shopifyProductVariantRecords =2 await api.shopifyProductVariant.findMany();3if (4 shopifyProductVariantRecords.hasNextPage5) {6 const nextPage =7 await shopifyProductVariantRecords.nextPage();8}9if (10 shopifyProductVariantRecords.hasPreviousPage11) {12 const prevPage =13 await shopifyProductVariantRecords.previousPage();14}
Selecting fields, and fields of fields
When using the JavaScript client, all of findOne, maybeFindOne, findMany, findFirst, maybeFindFirst, and various action functions, allow requesting specific fields of a Shopify Product Variant and its relationships. The select option controls which fields are selected in the generated GraphQL query sent to the Gadget API. Pass each field you want to select in an object, with true as the value for scalar fields, and a nested object of the same shape for nested fields.
Gadget has a default selection that will retrieve all of the scalar fields for a Shopify Product Variant, as well as concise representations of each of the relationships containing an id and an automatically inferred title field. If you don't pass a select option to a record finder, this default selection will be used.
// fetch only the id, state, and createdAt fieldconst shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({select: { id: true, state: true, createdAt: true },});
// fetch only the id, state, and createdAt fieldconst [result, refresh] = useFindMany(api.shopifyProductVariant, {select: { id: true, state: true, createdAt: true },});const { data, error, fetching } = result;
Type Safety
The select option is fully type safe if you're using TypeScript. The returned GadgetRecord type will have a <Shape> exactly matching the fields and nested fields you selected. For more information, see Type Safety
.
This behavior of selecting only some fields is built right into GraphQL. If you want to limit or expand what you retrieve from a GraphQL query, include or exclude those fields in your GraphQL query. For more information on executing GraphQL queries, see GraphQL.
1// fetch the id, state, and createdAt field, and fetch some nested fields from an example relationship field named `someRelatedObject`2const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({3 select: {4 id: true,5 state: true,6 createdAt: true,7 someRelatedObject: { id: true, createdAt: true },8 },9});
1// fetch the id, state, and createdAt field, and fetch some nested fields from an example relationship field named `someRelatedObject`2const [result, refresh] = useFindMany(api.shopifyProductVariant, {3 select: {4 id: true,5 state: true,6 createdAt: true,7 someRelatedObject: { id: true, createdAt: true },8 },9});10const { data, error, fetching } = result;
Combining parameters
Sort, search, filtering, selection, and pagination parameters can be combined to access the exact set of records needed for your use case.
1const shopifyProductVariantRecords = await api.shopifyProductVariant.findMany({2 search: "<some search query>",3 sort: { createdAt: "Descending" },4 filter: { updatedAt: { greaterThan: new Date(Date.now() - 864e5) } },5 select: { id: true, createdAt: true },6 first: 25,7 after: "abcdefg",8});
1const [result, refresh] = useFindMany(api.shopifyProductVariant, {2 search: "<some search query>",3 sort: { createdAt: "Descending" },4 filter: { updatedAt: { greaterThan: new Date(Date.now() - 864e5) } },5 select: { id: true, createdAt: true },6 first: 25,7 after: "abcdefg",8});9const { data, error, fetching } = result;
1query FindManyShopifyProductVariants(2 $after: String3 $before: String4 $first: Int5 $last: Int6 $search: String7 $sort: [ShopifyProductVariantSort!]8 $filter: [ShopifyProductVariantFilter!]9) {10 shopifyProductVariants(11 after: $after12 before: $before13 first: $first14 last: $last15 search: $search16 sort: $sort17 filter: $filter18 ) {19 edges {20 cursor21 node {22 __typename23 id24 state25 barcode26 compareAtPrice27 createdAt28 fulfillmentService29 grams30 inventoryManagement31 inventoryPolicy32 inventoryQuantity33 inventoryQuantityAdjustment34 oldInventoryQuantity35 option136 option237 option338 position39 presentmentPrices40 price41 product {42 id43 state44 body45 createdAt46 handle47 productType48 publishedAt49 publishedScope50 shop {51 id52 state53 accessToken54 address155 address256 checkoutApiSupported57 city58 cookieConsentLevel59 country60 countryCode61 countryName62 countyTaxes63 createdAt64 currency65 customerEmail66 domain67 eligibleForCardReaderGiveaway68 eligibleForPayments69 email70 enabledPresentmentCurrencies71 finances72 forceSsl73 googleAppsDomain74 googleAppsLoginEnabled75 grantedScopes76 hasDiscounts77 hasGiftCards78 hasStorefront79 ianaTimezone80 installedViaApiKey81 latitude82 longitude83 moneyFormat84 moneyInEmailsFormat85 moneyWithCurrencyFormat86 moneyWithCurrencyInEmailsFormat87 multiLocationEnabled88 myshopifyDomain89 name90 passwordEnabled91 phone92 planDisplayName93 planName94 preLaunchEnabled95 primaryLocale96 province97 provinceCode98 registeredWebhooks99 requiresExtraPaymentsAgreement100 setupRequired101 shopOwner102 shopifyCreatedAt103 shopifyUpdatedAt104 source105 taxShipping106 taxesIncluded107 timezone108 updatedAt109 weightUnit110 zipCode111 }112 shopifyCreatedAt113 shopifyUpdatedAt114 tags115 templateSuffix116 title117 updatedAt118 vendor119 }120 productImage {121 id122 state123 createdAt124 height125 position126 product {127 id128 state129 body130 createdAt131 handle132 productType133 publishedAt134 publishedScope135 shopifyCreatedAt136 shopifyUpdatedAt137 tags138 templateSuffix139 title140 updatedAt141 vendor142 }143 shop {144 id145 state146 accessToken147 address1148 address2149 checkoutApiSupported150 city151 cookieConsentLevel152 country153 countryCode154 countryName155 countyTaxes156 createdAt157 currency158 customerEmail159 domain160 eligibleForCardReaderGiveaway161 eligibleForPayments162 email163 enabledPresentmentCurrencies164 finances165 forceSsl166 googleAppsDomain167 googleAppsLoginEnabled168 grantedScopes169 hasDiscounts170 hasGiftCards171 hasStorefront172 ianaTimezone173 installedViaApiKey174 latitude175 longitude176 moneyFormat177 moneyInEmailsFormat178 moneyWithCurrencyFormat179 moneyWithCurrencyInEmailsFormat180 multiLocationEnabled181 myshopifyDomain182 name183 passwordEnabled184 phone185 planDisplayName186 planName187 preLaunchEnabled188 primaryLocale189 province190 provinceCode191 registeredWebhooks192 requiresExtraPaymentsAgreement193 setupRequired194 shopOwner195 shopifyCreatedAt196 shopifyUpdatedAt197 source198 taxShipping199 taxesIncluded200 timezone201 updatedAt202 weightUnit203 zipCode204 }205 shopifyCreatedAt206 shopifyUpdatedAt207 source208 updatedAt209 width210 }211 requiresShipping212 results {213 edges {214 node {215 id216 state217 body218 createdAt219 imageUrl220 productSuggestion {221 id222 state223 barcode224 compareAtPrice225 createdAt226 fulfillmentService227 grams228 inventoryManagement229 inventoryPolicy230 inventoryQuantity231 inventoryQuantityAdjustment232 oldInventoryQuantity233 option1234 option2235 option3236 position237 presentmentPrices238 price239 requiresShipping240 shopifyCreatedAt241 shopifyUpdatedAt242 sku243 taxCode244 taxable245 title246 updatedAt247 weight248 weightUnit249 }250 quiz {251 id252 state253 body254 createdAt255 title256 updatedAt257 }258 updatedAt259 }260 }261 }262 shop {263 id264 state265 accessToken266 address1267 address2268 checkoutApiSupported269 city270 cookieConsentLevel271 country272 countryCode273 countryName274 countyTaxes275 createdAt276 currency277 customerEmail278 domain279 eligibleForCardReaderGiveaway280 eligibleForPayments281 email282 enabledPresentmentCurrencies283 finances284 forceSsl285 googleAppsDomain286 googleAppsLoginEnabled287 grantedScopes288 hasDiscounts289 hasGiftCards290 hasStorefront291 ianaTimezone292 installedViaApiKey293 latitude294 longitude295 moneyFormat296 moneyInEmailsFormat297 moneyWithCurrencyFormat298 moneyWithCurrencyInEmailsFormat299 multiLocationEnabled300 myshopifyDomain301 name302 passwordEnabled303 phone304 planDisplayName305 planName306 preLaunchEnabled307 primaryLocale308 province309 provinceCode310 registeredWebhooks311 requiresExtraPaymentsAgreement312 setupRequired313 shopOwner314 shopifyCreatedAt315 shopifyUpdatedAt316 source317 taxShipping318 taxesIncluded319 timezone320 updatedAt321 weightUnit322 zipCode323 }324 shopifyCreatedAt325 shopifyUpdatedAt326 sku327 taxCode328 taxable329 title330 updatedAt331 weight332 weightUnit333 }334 }335 pageInfo {336 endCursor337 hasNextPage338 hasPreviousPage339 startCursor340 }341 }342}
1{2 "search": "<some search query>",3 "sort": {4 "createdAt": "Descending"5 },6 "filter": {7 "updatedAt": {8 "greaterThan": "2022-10-03T07:40:52.657Z"9 }10 },11 "first": 25,12 "after": "abcdefg"13}
Invoking Actions
Shopify Product Variant records are changed by invoking Actions. Actions are the things that "do" stuff -- update records, make API calls, call backend code, etc. Actions each have one corresponding GraphQL mutation and a corresponding function available in the API client libraries. Nested Actions can also be invoked with the API client, by providing the actions as input to any relationship fields.
Action Result format
Each API action returns results in the same format that includes a success indicator, errors, and the actual result if the action succeeded. The result is the record that was acted on for a model action, or a list of records for a bulk action, or a JSON blob for Global Actions. Model actions that delete the record don't return the record.
The success field returns a boolean indicating if the action executed as expected. Any execution errors are returned in the errors object, which will always be null if success is true or contain ExecutionError objects if success is false.
ExecutionError objects always have a message describing what error prevented the action from succeeding, as well as a code attribute that gives a stable, searchable, human readable error class code for referencing this specific error. Details on each error code can be found in the Errors documentation. All ExecutionError object types returned by the GraphQL object can be one of many types of error, where some types have extra data that is useful for remedying the error. All error types will always have message and code properties, but some, like InvalidRecordError have extra fields for use by clients.
Errors when using the generated client
The generated JavaScript client automatically interprets errors from invoking actions and throws JavaScript Error instances if the action didn't succeed. The Error objects it throws are rich, and expose extra error properties beyond just message and code if they exist.
Errors thrown by the JavaScript client are easiest to catch by using a try/catch statement around an await, like so:
1import {2 GadgetOperationError,3 InvalidRecordError,4} from "@gadget-client/example-app";56// must be in an async function to use `await` syntax7const runAction = async () => {8 try {9 return await api.exampleModel.create(10 {11 exampleModel: {12 name: "example record name",13 },14 }15 );16 } catch (error) {17 if (18 error instanceof19 GadgetOperationError20 ) {21 // a recognized general error has occurred, retry the operation or inspect error.code`22 console.error(error);23 } else if (24 error instanceof25 InvalidRecordError26 ) {27 // the submitted input data for the action was invalid, inspect the invalid fields which `InvalidRecordError` exposes28 console.error(29 error.validationErrors30 );31 } else {32 // an unrecognized error occurred, like an HTTP connection interrupted error or a syntax error. Re-throw it because it's not clear what to do to fix ti33 throw error;34 }35 }36};
For more information on error codes, consult the Errors documentation.
Shopify Product Variant Create
The Create action transitions a Shopify Product Variant from Start to Created.
Input
Create accepts the following input parameters:
1export interface CreateShopifyProductVariantInput {2 id?: (Scalars["GadgetID"] | null) | null;34 barcode?: (Scalars["String"] | null) | null;56 compareAtPrice?: (Scalars["String"] | null) | null;78 fulfillmentService?: (Scalars["String"] | null) | null;910 grams?: (Scalars["Float"] | null) | null;1112 inventoryManagement?: (Scalars["String"] | null) | null;1314 inventoryPolicy?: (Scalars["String"] | null) | null;1516 productImage?: ShopifyProductImageBelongsToInput | null;1718 inventoryQuantity?: (Scalars["Float"] | null) | null;1920 inventoryQuantityAdjustment?: (Scalars["Float"] | null) | null;2122 oldInventoryQuantity?: (Scalars["Float"] | null) | null;2324 option1?: (Scalars["String"] | null) | null;2526 option2?: (Scalars["String"] | null) | null;2728 option3?: (Scalars["String"] | null) | null;2930 position?: (Scalars["Float"] | null) | null;3132 presentmentPrices?: (Scalars["JSON"] | null) | null;3334 price?: (Scalars["String"] | null) | null;3536 requiresShipping?: (Scalars["Boolean"] | null) | null;3738 product?: ShopifyProductBelongsToInput | null;3940 shopifyCreatedAt?: Date | Scalars["ISO8601DateString"] | null;4142 sku?: (Scalars["String"] | null) | null;4344 taxCode?: (Scalars["String"] | null) | null;4546 shopifyUpdatedAt?: Date | Scalars["ISO8601DateString"] | null;4748 taxable?: (Scalars["Boolean"] | null) | null;4950 title?: (Scalars["String"] | null) | null;5152 weight?: (Scalars["Float"] | null) | null;5354 weightUnit?: (Scalars["String"] | null) | null;5556 shop?: ShopifyShopBelongsToInput | null;5758 results?: (ResultHasManyInput | null)[];59}6061export interface CreateShopifyProductVariantArguments {62 shopifyProductVariant?: CreateShopifyProductVariantInput | null;63}
1input CreateShopifyProductVariantInput {2 id: GadgetID3 barcode: String4 compareAtPrice: String5 fulfillmentService: String6 grams: Float7 inventoryManagement: String8 inventoryPolicy: String9 productImage: ShopifyProductImageBelongsToInput10 inventoryQuantity: Float11 inventoryQuantityAdjustment: Float12 oldInventoryQuantity: Float13 option1: String14 option2: String15 option3: String16 position: Float17 presentmentPrices: JSON18 price: String19 requiresShipping: Boolean20 product: ShopifyProductBelongsToInput21 shopifyCreatedAt: DateTime22 sku: String23 taxCode: String24 shopifyUpdatedAt: DateTime25 taxable: Boolean26 title: String27 weight: Float28 weightUnit: String29 shop: ShopifyShopBelongsToInput30 results: [ResultHasManyInput]31}3233input CreateShopifyProductVariantArguments {34 shopifyProductVariant: CreateShopifyProductVariantInput35}
1const shopifyProductVariantRecord = await api.shopifyProductVariant.create({2 shopifyProductVariant: {3 // field values for Shopify Product Variant4 },5});6console.log(shopifyProductVariantRecord.id); //=> a string
1const [result, createShopifyProductVariant] = useAction(2 api.shopifyProductVariant.create3);4const { data, error, fetching } = result;5await createShopifyProductVariant({6 shopifyProductVariant: {7 // field values for Shopify Product Variant8 },9});10console.log(data?.id); //=> a string
1mutation ($shopifyProductVariant: CreateShopifyProductVariantInput) {2 createShopifyProductVariant(shopifyProductVariant: $shopifyProductVariant) {3 success4 errors {5 message6 ... on InvalidRecordError {7 validationErrors {8 apiIdentifier9 message10 }11 record12 model {13 apiIdentifier14 }15 }16 }17 shopifyProductVariant {18 __typename19 id20 state21 barcode22 compareAtPrice23 createdAt24 fulfillmentService25 grams26 inventoryManagement27 inventoryPolicy28 inventoryQuantity29 inventoryQuantityAdjustment30 oldInventoryQuantity31 option132 option233 option334 position35 presentmentPrices36 price37 product {38 id39 state40 body41 createdAt42 handle43 productType44 publishedAt45 publishedScope46 shop {47 id48 state49 accessToken50 address151 address252 checkoutApiSupported53 city54 cookieConsentLevel55 country56 countryCode57 countryName58 countyTaxes59 createdAt60 currency61 customerEmail62 domain63 eligibleForCardReaderGiveaway64 eligibleForPayments65 email66 enabledPresentmentCurrencies67 finances68 forceSsl69 googleAppsDomain70 googleAppsLoginEnabled71 grantedScopes72 hasDiscounts73 hasGiftCards74 hasStorefront75 ianaTimezone76 installedViaApiKey77 latitude78 longitude79 moneyFormat80 moneyInEmailsFormat81 moneyWithCurrencyFormat82 moneyWithCurrencyInEmailsFormat83 multiLocationEnabled84 myshopifyDomain85 name86 passwordEnabled87 phone88 planDisplayName89 planName90 preLaunchEnabled91 primaryLocale92 province93 provinceCode94 registeredWebhooks95 requiresExtraPaymentsAgreement96 setupRequired97 shopOwner98 shopifyCreatedAt99 shopifyUpdatedAt100 source101 taxShipping102 taxesIncluded103 timezone104 updatedAt105 weightUnit106 zipCode107 }108 shopifyCreatedAt109 shopifyUpdatedAt110 tags111 templateSuffix112 title113 updatedAt114 vendor115 }116 productImage {117 id118 state119 createdAt120 height121 position122 product {123 id124 state125 body126 createdAt127 handle128 productType129 publishedAt130 publishedScope131 shopifyCreatedAt132 shopifyUpdatedAt133 tags134 templateSuffix135 title136 updatedAt137 vendor138 }139 shop {140 id141 state142 accessToken143 address1144 address2145 checkoutApiSupported146 city147 cookieConsentLevel148 country149 countryCode150 countryName151 countyTaxes152 createdAt153 currency154 customerEmail155 domain156 eligibleForCardReaderGiveaway157 eligibleForPayments158 email159 enabledPresentmentCurrencies160 finances161 forceSsl162 googleAppsDomain163 googleAppsLoginEnabled164 grantedScopes165 hasDiscounts166 hasGiftCards167 hasStorefront168 ianaTimezone169 installedViaApiKey170 latitude171 longitude172 moneyFormat173 moneyInEmailsFormat174 moneyWithCurrencyFormat175 moneyWithCurrencyInEmailsFormat176 multiLocationEnabled177 myshopifyDomain178 name179 passwordEnabled180 phone181 planDisplayName182 planName183 preLaunchEnabled184 primaryLocale185 province186 provinceCode187 registeredWebhooks188 requiresExtraPaymentsAgreement189 setupRequired190 shopOwner191 shopifyCreatedAt192 shopifyUpdatedAt193 source194 taxShipping195 taxesIncluded196 timezone197 updatedAt198 weightUnit199 zipCode200 }201 shopifyCreatedAt202 shopifyUpdatedAt203 source204 updatedAt205 width206 }207 requiresShipping208 results {209 edges {210 node {211 id212 state213 body214 createdAt215 imageUrl216 productSuggestion {217 id218 state219 barcode220 compareAtPrice221 createdAt222 fulfillmentService223 grams224 inventoryManagement225 inventoryPolicy226 inventoryQuantity227 inventoryQuantityAdjustment228 oldInventoryQuantity229 option1230 option2231 option3232 position233 presentmentPrices234 price235 requiresShipping236 shopifyCreatedAt237 shopifyUpdatedAt238 sku239 taxCode240 taxable241 title242 updatedAt243 weight244 weightUnit245 }246 quiz {247 id248 state249 body250 createdAt251 title252 updatedAt253 }254 updatedAt255 }256 }257 }258 shop {259 id260 state261 accessToken262 address1263 address2264 checkoutApiSupported265 city266 cookieConsentLevel267 country268 countryCode269 countryName270 countyTaxes271 createdAt272 currency273 customerEmail274 domain275 eligibleForCardReaderGiveaway276 eligibleForPayments277 email278 enabledPresentmentCurrencies279 finances280 forceSsl281 googleAppsDomain282 googleAppsLoginEnabled283 grantedScopes284 hasDiscounts285 hasGiftCards286 hasStorefront287 ianaTimezone288 installedViaApiKey289 latitude290 longitude291 moneyFormat292 moneyInEmailsFormat293 moneyWithCurrencyFormat294 moneyWithCurrencyInEmailsFormat295 multiLocationEnabled296 myshopifyDomain297 name298 passwordEnabled299 phone300 planDisplayName301 planName302 preLaunchEnabled303 primaryLocale304 province305 provinceCode306 registeredWebhooks307 requiresExtraPaymentsAgreement308 setupRequired309 shopOwner310 shopifyCreatedAt311 shopifyUpdatedAt312 source313 taxShipping314 taxesIncluded315 timezone316 updatedAt317 weightUnit318 zipCode319 }320 shopifyCreatedAt321 shopifyUpdatedAt322 sku323 taxCode324 taxable325 title326 updatedAt327 weight328 weightUnit329 }330 }331}
{"shopifyProductVariant": {}}
Output
Create returns the Shopify Product Variant. In the JS client, the fields returned can be controlled with the select option. In GraphQL, the return format is the action result format, which includes the record if the action was successful. You can include or exclude the fields you need right in the mutation itself.
type CreateShopifyProductVariantResult {success: Boolean!errors: [ExecutionError!]shopifyProductVariant: ShopifyProductVariant}
Shopify Product Variant Delete
The Delete action destroys the record.
Input
Delete operates on one Shopify Product Variant in particular, identified by the id variable.
await api.shopifyProductVariant.delete("some-id");
1const [result, deleteShopifyProductVariant] = useAction(2 api.shopifyProductVariant.delete3);4const { data, error, fetching } = result;5await deleteShopifyProductVariant({6 id: "some-id",7});
1mutation ($id: GadgetID!) {2 deleteShopifyProductVariant(id: $id) {3 success4 errors {5 message6 ... on InvalidRecordError {7 validationErrors {8 apiIdentifier9 message10 }11 record12 model {13 apiIdentifier14 }15 }16 }17 }18}
{"id": "some-id"}
Output
Delete deletes the record, so it returns void in the JS client. In GraphQL it returns only the success and errors from the action result format.
type DeleteShopifyProductVariantResult {success: Boolean