Shopify API version changelog 

Shopify releases a new API version every 3 months at the beginning of the quarter, and each stable version is supported for a minimum of 12 months. This generally means that a given version will become unsupported after 12 months has elapsed since its release. Shopify recommends updating your apps to make requests to the latest stable API version every quarter. Gadget makes this process simple by allowing you to edit your Shopify Connection's API version. The following are the changes to Shopify models in Gadget by version:

2025-01 Changelog 

Shopify Customer Payment Method 

New enum option added to:

  • Enum option PAYMENT_METHOD_VERIFICATION_FAILED to revokedReason
  • Enum option THREE_D_SECURE_FLOW_IN_VERIFICATION_NOT_IMPLEMENTED to revokedReason

Shopify Location 

Fields disconnected on the Shopify Location model:

  • localizedCountryName
  • localizedProvinceName

Shopify Subscription Contract 

Fields added to the Shopify Subscription Contract model:

  • concatenatedLines

Shopify Subscription Line 

Fields added to the Shopify Subscription Line model:

  • concatenatedOriginContract

Shopify Product Image 

The Shopify Product Image model is no longer supported. Fields disconnected on the Shopify Product Image model:

  • id
  • alt
  • height
  • position
  • product
  • shopifyCreatedAt
  • shopifyUpdatedAt
  • source
  • variants
  • width
  • shop

2024-10 Changelog 

Shopify Customer Payment Method 

New enum option added to:

  • Enum option FAILED_TO_RETRIEVE_BILLING_ADDRESS to revokedReason

Shopify Fulfillment Service 

Fields disconnected on the Shopify Fulfillment Service model:

  • shippingMethods

Shopify Gift Card 

Fields disconnected on the Shopify Gift Card model:

  • disabledAt

Fields added to the Shopify Gift Card model:

  • deactivatedAt

Shopify Order 

Fields added to the Shopify Order model:

  • totalCashRoundingAdjustment
  • statusPageURL
  • businessEntity

Shopify Shop 

Fields added to the Shopify Shop model:

  • shopifyPaymentsAccount
  • shopifyBusinessEntity

Shopify Subscription Contract 

Fields added to the Shopify Subscription Contract model:

  • lastBillingAttemptErrorType

2024-07 Changelog 

Shopify Balance Transaction 

Fields added to the Shopify Balance Transaction model:

  • adjustmentReason

Shopify Customer 

Fields added to the Shopify Customer model:

  • dataSaleOptOut
  • storeCreditAccounts

Shopify Draft Order 

Fields added to the Shopify Draft Order model:

  • discountCodes
  • acceptAutomaticDiscounts
  • allowDiscountCodesInCheckout
  • warnings
  • billingAddressMatchesShippingAddress
  • defaultCursor
  • hasTimelineComment
  • invoiceEmailTemplateSubject
  • legacyResourceId
  • lineItemsSubtotalPrice
  • marketName
  • marketRegionCountryCode
  • phone
  • platformDiscounts
  • presentmentCurrencyCode
  • ready
  • reserveInventoryUntil
  • subtotalPriceSet
  • totalDiscountsSet
  • totalPriceSet
  • totalLineItemsPriceSet
  • totalQuantityOfLineItems
  • totalShippingPriceSet
  • totalTaxSet
  • totalWeight
  • transformerFingerprint
  • visibleToCustomer

Shopify Draft Order Line Item 

Fields disconnected on the Shopify Draft Order Line Item model:

  • grams

Fields added to the Shopify Draft Order Line Item model:

  • approximateDiscountedUnitPriceSet
  • bundleComponents
  • discountedTotalSet
  • fulfillmentServiceHandle
  • originalTotalSet
  • originalUnitPriceSet
  • originalUnitPriceWithCurrency
  • totalDiscountSet
  • uUID
  • customAttributes
  • customAttributesV2
  • weight

Shopify File 

Fields added to the Shopify File model:

  • shopifyUpdatedAt
  • embedUrl
  • host
  • mediaContentType
  • mediaErrors
  • mediaWarnings
  • originUrl
  • status
  • boundingBox
  • filename
  • product
  • productVariant

Shopify Fulfillment Order Line Item 

Fields added to the Shopify Fulfillment Order Line Item model:

  • variant

Shopify Fulfillment Service 

Fields added to the Shopify Fulfillment Service model:

  • adminGraphQLAPIID
  • draftOrderLineItem

Shopify Location 

Fields added to the Shopify Location model:

  • retailOrders

Shopify Order 

Fields added to the Shopify Order model:

  • retailLocation
  • fulfillmentsCount
  • transactionsCount
  • draftOrder

Shopify Product 

Fields added to the Shopify Product model:

  • media
  • featuredMedia
  • hasVariantsThatRequiresComponents

Shopify Product Variant 

Fields disconnected on the Shopify Product Variant model:

  • fulfillmentService
  • inventoryManagement
  • requiresShipping
  • weight
  • weightUnit

Fields added to the Shopify Product Variant model:

  • fulfillmentOrderLineItem
  • media

Shopify Shop 

Fields added to the Shopify Shop model:

  • draftOrderPlatformDiscount
  • draftOrderPlatformDiscountAllocation
  • productMedia
  • productVariantMedia
  • storeCreditAccount

Shopify Selling Plan 

Other:

  • Metafield support added for this model

2024-04 Changelog 

Shopify Company 

Fields deprecated on the Shopify Company model:

  • contactCount

Fields disconnected on the Shopify Company model:

  • orderCount
  • locationCount

Fields added to the Shopify Company model:

  • contactsCount
  • ordersCount
  • locationsCount

Shopify Company Location 

Fields disconnected on the Shopify Company Location model:

  • orderCount

Fields added to the Shopify Company Location model:

  • ordersCount
  • catalogs

Shopify Discount 

Fields disconnected on the Shopify Discount model:

  • codeCount

Fields added to the Shopify Discount model:

  • codesCount

Other:

  • Metafield support added for this model

Shopify Fulfillment Service 

Fields deprecated on the Shopify Fulfillment Service model:

  • fulfillmentOrdersOptIn

Shopify Inventory Item 

Fields added to the Shopify Inventory Item model:

  • measurement

Shopify Market 

Fields added to the Shopify Market model:

  • marketCatalogs

Shopify Order 

Fields deprecated on the Shopify Order model:

  • risks

Fields added to the Shopify Order model:

  • risk

Shopify Product 

Fields deprecated on the Shopify Product model:

  • productCategory

Fields disconnected on the Shopify Product model:

  • publishedScope

Fields added to the Shopify Product model:

  • category

Shopify Product Variant 

Fields deprecated on the Shopify Product Variant model:

  • fulfillmentService
  • inventoryManagement
  • requiresShipping
  • weight
  • weightUnit

Fields disconnected on the Shopify Product Variant model:

  • grams
  • inventoryQuantityAdjustment
  • oldInventoryQuantity

Fields added to the Shopify Product Variant model:

  • selectedOptions
  • priceListPrice
  • quantityPriceBreaks

Shopify Shipping Line 

Fields added to the Shopify Shipping Line model:

  • isRemoved

Shopify Shop 

Fields added to the Shopify Shop model:

  • catalog
  • companyLocationCatalog
  • marketCatalog
  • priceList
  • priceListPrice
  • quantityPriceBreak

Shopify Subscription Billing Attempt 

New enum option added to:

  • Enum option AMOUNT_TOO_SMALL to errorCode
  • Enum option CARD_NUMBER_INCORRECT to errorCode
  • Enum option FRAUD_SUSPECTED to errorCode
  • Enum option INSUFFICIENT_FUNDS to errorCode
  • Enum option INVALID_CUSTOMER_BILLING_AGREEMENT to errorCode
  • Enum option INVENTORY_ALLOCATIONS_NOT_FOUND to errorCode
  • Enum option INVOICE_ALREADY_PAID to errorCode
  • Enum option PAYMENT_METHOD_INCOMPATIBLE_WITH_GATEWAY_CONFIG to errorCode
  • Enum option PAYPAL_ERROR_GENERAL to errorCode
  • Enum option PURCHASE_TYPE_NOT_SUPPORTED to errorCode
  • Enum option TRANSIENT_ERROR to errorCode

2024-01 Changelog 

Shopify Balance Transaction 

Fields added to the Shopify Balance Transaction model:

  • adjustmentOrderTransactions

Shopify Checkout 

Fields deprecated on the Shopify Checkout model:

  • discountCode

Fields added to the Shopify Checkout model:

  • discountCodes

Shopify Customer 

Fields added to the Shopify Customer model:

  • locale

Shopify Discount 

Fields added to the Shopify Discount model:

  • type

Shopify Draft Order 

Fields added to the Shopify Draft Order model:

  • paymentTerms

Shopify Order 

Fields added to the Shopify Order model:

  • paymentTerms

Shopify Order Line Item 

Fields added to the Shopify Order Line Item model:

  • currentQuantity

Shopify Order Transaction 

Fields added to the Shopify Order Transaction model:

  • multicapturable

Shopify Shop 

Fields added to the Shopify Shop model:

  • plan
  • paymentTerms
  • paymentSchedule

Shopify Subscription Contract 

Fields added to the Shopify Subscription Contract model:

  • revisionId

2023-10 Changelog 

Shopify Customer Payment Method 

New enum option added to:

  • Enum option MERGED to revokedReason
  • Enum option BRAINTREE_API_AUTHENTICATION_ERROR to revokedReason
  • Enum option BRAINTREE_GATEWAY_NOT_ENABLED to revokedReason
  • Enum option BRAINTREE_PAYMENT_METHOD_NOT_CARD to revokedReason
  • Enum option BRAINTREE_RETURNED_NO_PAYMENT_METHOD to revokedReason

Shopify Draft Order Line Item 

Fields added to the Shopify Draft Order Line Item model:

  • custom

Shopify File 

Fields added to the Shopify File model:

  • mimetype

Shopify Fulfillment Service 

Fields deprecated on the Shopify Fulfillment Service model:

  • requiresShippingMethod

Fields added to the Shopify Fulfillment Service model:

  • serviceName
  • type
  • shippingMethods

Shopify Inventory Item 

Fields added to the Shopify Inventory Item model:

  • inventoryHistoryUrl

Shopify Market 

Fields added to the Shopify Market model:

  • marketWebPresences

Shopify Market Web Presence 

Fields added to the Shopify Market Web Presence model:

  • primaryWebPresenceForMarket

Shopify Order 

Fields deprecated on the Shopify Order model:

  • location

Fields added to the Shopify Order model:

  • cancellation
  • shopifyProtect

Shopify Product 

Fields added to the Shopify Product model:

  • compareAtPriceRange

Shopify Shop 

Fields added to the Shopify Shop model:

  • customerAccountsV2

2023-07 Changelog 

Shopify Collection 

Fields added to the Shopify Collection model:

  • customerGetsThroughDiscounts
  • customerBuysThroughDiscounts

Shopify Customer 

Fields added to the Shopify Customer model:

  • mergeable

Shopify Discount 

Fields added to the Shopify Discount model:

  • customerGets
  • customerGetsProducts
  • customerGetsProductVariants
  • customerGetsCollections
  • customerBuys
  • customerBuysProducts
  • customerBuysProductVariants
  • customerBuysCollections
  • codes

Shopify Draft Order 

Fields added to the Shopify Draft Order model:

  • pONumber

Shopify Fulfillment Order 

Fields added to the Shopify Fulfillment Order model:

  • shopifyCreatedAt
  • shopifyUpdatedAt
  • location

Shopify Inventory Item 

Fields added to the Shopify Inventory Item model:

  • duplicateSkuCount
  • legacyResourceId
  • trackedEditable
  • unitCost

Shopify Inventory Level 

Fields added to the Shopify Inventory Level model:

  • adminGraphQLAPIID
  • canDeactivate
  • deactivationAlert

Shopify Location 

Fields added to the Shopify Location model:

  • fulfillmentOrders

Shopify Order 

Fields added to the Shopify Order model:

  • taxExempt
  • pONumber

Shopify Order Line Item 

Fields added to the Shopify Order Line Item model:

  • attributedStaffs

Shopify Product 

Fields added to the Shopify Product model:

  • customerGetsThroughDiscounts
  • customerBuysThroughDiscounts

Shopify Product Variant 

Fields added to the Shopify Product Variant model:

  • customerGetsThroughDiscounts
  • customerBuysThroughDiscounts

Shopify Shipping Line 

Fields disconnected on the Shopify Shipping Line model:

  • deliveryCategory

Shopify Shop 

Fields added to the Shopify Shop model:

  • discountRedeemCodes
  • discountCustomerBuysCollections
  • discountCustomerGetsCollections
  • discountCustomerBuysProducts
  • discountCustomerGetsProducts
  • discountCustomerBuysProductVariants
  • discountCustomerGetsProductVariants

2023-04 Changelog 

Shopify Customer 

Fields added to the Shopify Customer model:

  • companyContacts

Shopify Draft Order 

Fields added to the Shopify Draft Order model:

  • purchasingCompany
  • purchasingCompanyContact
  • purchasingCompanyLocation
  • purchasingEntity

Shopify Fulfillment Order Line Item 

Fields added to the Shopify Fulfillment Order Line Item model:

  • inventoryItem

Shopify Inventory Item 

Fields added to the Shopify Inventory Item model:

  • fulfillmentOrderLineItem

Shopify Market 

Fields added to the Shopify Market model:

  • companyLocations

Other:

  • Metafield support added for this model

Shopify Order 

Fields disconnected on the Shopify Order model:

  • gateway
  • paymentDetails
  • processingMethod

Fields added to the Shopify Order model:

  • currentTotalAdditionalFeesSet
  • originalTotalAdditionalFeesSet
  • additionalFees
  • purchasingEntity
  • purchasingCompany
  • purchasingCompanyContact
  • purchasingCompanyLocation

Shopify Order Line Item 

Fields added to the Shopify Order Line Item model:

  • fulfillableQuantity
  • fulfillmentService
  • fulfillmentStatus
  • grams
  • productExists
  • variantInventoryManagement

Shopify Order Transaction 

Fields added to the Shopify Order Transaction model:

  • totalUnsettledSet

Shopify Shop 

Fields added to the Shopify Shop model:

  • company
  • companyContact
  • companyContactRole
  • companyContactRoleAssignment
  • companyLocation
  • companyAddress

Shopify Company 

New webhooks are available:

  • companies/create
  • companies/update
  • companies/delete
  • Shopify Company Contact 

    New webhooks are available:

  • company_contacts/create
  • company_contacts/update
  • company_contacts/delete
  • Shopify Company Location 

    New webhooks are available:

  • company_locations/create
  • company_locations/update
  • company_locations/delete
  • Shopify Fulfillment Order 

    New webhooks are available:

  • fulfillment_orders/moved
  • 2023-01 Changelog 

    Shopify Order Transaction 

    Fields added to the Shopify Order Transaction model:

    • paymentID

    Shopify Company Location 

    Other:

    • Metafield support added for this model

    Shopify Fulfillment Order 

    New webhooks are available:

  • fulfillment_orders/order_routing_complete
  • fulfillment_orders/fulfillment_request_submitted
  • fulfillment_orders/fulfillment_request_accepted
  • fulfillment_orders/fulfillment_request_rejected
  • fulfillment_orders/placed_on_hold
  • fulfillment_orders/cancellation_request_accepted
  • fulfillment_orders/cancellation_request_rejected
  • fulfillment_orders/cancelled
  • fulfillment_orders/fulfillment_service_failed_to_complete
  • Shopify Location 

    New webhooks are available:

  • locations/activate
  • locations/deactivate
  • 2022-10 Changelog 

    Shopify Order 

    Fields added to the Shopify Order model:

    • merchantOfRecordAppId

    Shopify Product 

    Fields added to the Shopify Product model:

    • productCategory

    Shopify Shop 

    Fields added to the Shopify Shop model:

    • transactionalSMSDisabled
    • marketingSMSContentEnabledAtCheckout

    Shopify Location 

    Other:

    • Metafield support added for this model

    2022-07 Changelog 

    Shopify Customer 

    Fields added to the Shopify Customer model:

    • statistics

    Shopify Dispute 

    Fields added to the Shopify Dispute model:

    • disputeEvidence

    Shopify Fulfillment Service 

    Fields added to the Shopify Fulfillment Service model:

    • permitsSKUSharing

    Shopify Shop 

    Fields added to the Shopify Shop model:

    • disputeEvidences
    • disputeFileUploads
    • disputeEvidenceFulfillments
    • discounts

    Shopify Selling Plan 

    Fields added to the Shopify Selling Plan model:

    • category
    • inventoryPolicy

    Shopify App Installation 

    Other:

    • Metafield support added for this model

    2022-04 Changelog 

    Shopify App 

    Fields added to the Shopify App model:

    • previouslyInstalled
    • requestedAccessScopes

    Shopify Customer 

    Fields deprecated on the Shopify Customer model:

    • acceptsMarketing
    • acceptsMarketingUpdatedAt
    • marketingOptInLevel

    Fields added to the Shopify Customer model:

    • emailMarketingConsent
    • sMSMarketingConsent
    • shopifyState

    Shopify Domain 

    Fields added to the Shopify Domain model:

    • marketWebPresences

    Shopify File 

    Fields added to the Shopify File model:

    • duration
    • originalFileSize

    Shopify Fulfillment Order 

    Fields added to the Shopify Fulfillment Order model:

    • fulfillBy

    Shopify Order 

    Fields added to the Shopify Order model:

    • sourceIdentifier
    • sourceURL

    Shopify Price Rule 

    Fields disconnected on the Shopify Price Rule model:

    • prerequisiteSavedSearchIds

    Fields added to the Shopify Price Rule model:

    • customerSegmentPrerequisiteIds

    Shopify Shop 

    Fields added to the Shopify Shop model:

    • markets
    • marketRegions
    • marketWebPresences

    Shopify Subscription Billing Attempt 

    Fields added to the Shopify Subscription Billing Attempt model:

    • originTime

    Was this page helpful?