Breaking Changes in Shopify API Version 2024-04

Shopify releases new and modified versions of their APIs on a quarterly schedule. The quarterly update for the 2024-04 version contains many breaking changes.

Workflows that utilize the Action Send a Shopify REST API Request or Custom Actions may be impacted, depending on the Action configuration. 

Impacted merchants will be notified in the app and each impacted workflow will be flagged in the interface as deprecated. If your workflows are not flagged, they are not impacted or deprecated.

Updates required for some workflows using the Send a Shopify REST API Request Action

The following specific REST API endpoints are now deprecated.  

Using these endpoints after November 1, 2024 will result in an error as they have been removed from the 2024-04 version of the Shopify API and Arigato Automation will begin using the 2024-04 version of the API on that date.

  • Checkouts
    • /checkouts
    • /checkouts/{token}/complete
    • /checkouts/{token}
    • /checkouts/{token}/shipping_rates
    • ... And any other REST endpoint within /checkouts 
  • Products
    • /products
    • /products/{product_id}
    • /products/{product_id}/metafields
    • ... And any other REST endpoint within /products 
  • Product Variants
    • /products/{product_id}/variants
    • /variants/{variant_id}
    • /variants/{variant_id}/metafields
    • ... And any other REST endpoint within /variants
  • Product Images
    • /products/{product_id}/images
    • /products/{product_id}/images/{image_id}
    • ... And any other REST endpoint for product images
  • Order Risks
    • /orders/{order_id}/risks
    • /orders/{order_id}/risks/{risk_id}
    • ... And any other REST endpoint for order risks

Updates required for some workflows using Custom Actions

Any Custom Action utilizing the   shopify_api_request Action and using a deprecated path (endpoint) must also be updated.

For example the following Custom Action is using a  path parameter that hits a deprecated API endpoint. This workflow would need to be updated.

{% set response = RUN_ACTION("shopify_api_request", {   method: "GET",   path: "products/" ~ product.id,   format: "product", }) %}

Updating Deprecated Workflows 

To avoid disruption, impacted merchants must migrate away from using the deprecated REST API endpoints and convert those deprecated workflows to use the Shopify GraphQL Action or GraphQL Custom Action syntax instead.

If you have any questions or need assistance, please reach out to our support team.    

Related Articles