Gadget framework
Glossary
FAQ

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:

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

Shopify Discount 

Fields disconnected on the Shopify Discount model:

  • codeCount

Fields added to the Shopify Discount model:

  • codesCount

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 Order 

Fields deprecated on the Shopify Order model:

  • risks

Fields added to the Shopify Order model:

  • risk

New webhooks are available:

  • orders/risk_assessment_changed

    • 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

    Shopify Shipping Line 

    Fields added to the Shopify Shipping Line model:

    • isRemoved

    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 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 Subscription Contract 

    Fields added to the Shopify Subscription Contract model:

    • revisionId

    Shopify Discount 

    New webhooks are available:

  • discounts/create
  • discounts/update
  • discounts/delete

    • Shopify Fulfillment Order 

    New webhooks are available:

  • fulfillment_orders/split
  • fulfillment_orders/merged

    • 2023-10 Changelog 

    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 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 Customer 

    Fields added to the Shopify Customer model:

    • mergeable

    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 Shipping Line 

    Fields disconnected on the Shopify Shipping Line model:

    • deliveryCategory

    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