Skip to content

Shopify

Full integration with the Shopify Admin API. It covers all main e-commerce operations: products (CRUD, variants, images), orders (query, create, update, cancel, close), refunds, fulfillment, customers, collections, inventory, discounts, webhooks and metafields.

Authentication is handled through the credentials module (service type shopify). Pagination and filters are built automatically.

ParameterTypeRequiredDescription
credentials_idcredentialsYesShopify credential
operationtextYesOperation to perform (over 35 operations available)
limitnumberNoResult limit (max 250)
statusselectNoStatus: active, draft, archived
product_idtextConditionalProduct ID
order_idtextConditionalOrder ID
customer_idtextConditionalCustomer ID
created_at_min / created_at_maxdatetimeNoCreation date range
financial_statustextNoOrder financial status
fulfillment_statustextNoOrder shipping status

Service type: shopify. Stored in the servicecredentials table.

  • shopDomain: Store domain (e.g.: my-store.myshopify.com)
  • accessToken: Private or custom app access token
  • apiVersion: API version (e.g.: 2024-01)
{
"nextModule": null,
"data": [
{ "id": 1234567890, "title": "Premium T-Shirt", "status": "active",
"variants": [{ "id": 111, "price": "29.99", "sku": "CAM-001" }] }
],
"_meta_": { "operation": "getProducts", "recordCount": 1, "executionTime": "200ms" }
}
  • The maximum record limit per request is 250 (imposed by Shopify).
  • Products are created in “draft” status by default.
  • Smart and custom collections use different endpoints.
  • The request timeout is 30 seconds.