HTTP Requests

HTTP API requests are highly configurable with many options. HTTP requests allow you to securely call any external API directly from your Shopify store or through other trigger methods such as webhooks, storefront app proxy, or a recurring schedule.

HTTP request fields

• Name: Optional display name.

• Handle: Stable identifier used by chained requests, storefront calls, apiease-cli, and the public API.

• Type: Choose HTTP for a standard API call to an external service.

• Address: Enter the full endpoint URL from the provider's API documentation (for example, https://api.example.com/data). Keep values that belong in the query string, path placeholders, or body in their matching parameter locations.

• Method: Choose the operation required by the provider: GET, POST, DELETE, PUT, PATCH, or OPTIONS.

• Parameters (?):

  • Headers: Add required headers (Authorization, Content-Type, etc.).
  • Query parameters: Values to include in the query string.
  • Body: Add the payload for methods such as POST, PUT, or PATCH. APIEase supports standard JSON bodies and form URL-encoded bodies.
  • Path: Dynamic path variables to substitute into the address.
  • System: Configure HTTP timeouts, response formats, and certificate verification, or other System Parameters.
  • You can provide in app parameters or pass dynamic embedded parameters from the storefront.
  • If the request includes credentials or API keys, mark them as Sensitive so they remain encrypted and never shown in the storefront or admin UI.

• Triggers (?): Choose how the request should be triggered:

  • Automatically via webhook
  • On a recurring schedule using cron
  • As an endpoint served by APIEase via Proxy Endpoints
  • Remote Calls from outside Shopify.
  • Manually via the "Copy and Execute" link on the requests admin page
  • From your storefront using Shopify's app proxy

• Next Request: You can implement chained requests by setting the Next Request field to the handle of a request to run after this one completes.

For a concise comparison of request types, parameter locations, and multi-step options, see the Building requests FAQ.