Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Mercaline2024/Ecomdrop-ia-connector-2/llms.txt

Use this file to discover all available pages before exploring further.

The Integrations API provides endpoints for configuring and managing external platform integrations.

​
Save Dropi Integration

Saves or updates Dropi integration settings for the shop. 
POST /api/integrations/dropi/save

​
Request Body (Form Data)

​
store_name
string
required
Dropi store name
​
country
string
required
Store country code (e.g., “US”, “MX”, “CO”)
​
dropi_token
string
Dropi integration API token (required for new configurations)

​
Response

​
success
boolean
Whether the configuration was saved successfully
​
configuration
object
Updated shop configuration
​
error
string
Error message (if success is false)

​
Example Response

{
  "success": true,
  "configuration": {
    "shop": "mystore.myshopify.com",
    "dropiStoreName": "My Store",
    "dropiCountry": "US",
    "dropiToken": "dropi_***************"
  }
}
The Dropi token is validated against the Ecomdrop API before being saved. Ecomdrop API key must be configured first.
When updating an existing configuration, the dropi_token parameter is optional. If not provided, the existing token will be preserved.

​
Ecomdrop Callback

Receives notifications from Ecomdrop when order processing is complete. This endpoint updates order tags based on the processing status. 
POST /api/ecomdrop/callback

​
Request Body (JSON)

​
apiKey
string
required
Ecomdrop API key for authentication (also accepts api_key or token)
​
orderName
string
required
Shopify order name (e.g., “#1001”) - primary identifier
​
orderId
string
Shopify order ID (GraphQL format: gid://shopify/Order/123)
​
shop
string
Shop domain (optional, determined from API key if not provided)
​
tag
string
Single tag to add to the order
​
tags
string | array
Multiple tags to add (string with comma separation or array)
​
status
string
Processing status - automatically maps to tags:
  • success → “ecomdrop-processed”
  • completed → “ecomdrop-completed”
  • pending → “ecomdrop-pending”
  • error or failed → “ecomdrop-error”

​
Response

​
success
boolean
Whether the callback was processed successfully
​
message
string
Success message with applied tags
​
orderId
string
Shopify order ID (GraphQL format)
​
tags
array
Tags that were added to the order
​
error
string
Error message (if success is false)

​
Example Request

{
  "apiKey": "ecomdrop_api_key_here",
  "orderName": "#1001",
  "status": "success"
}

​
Example Response

{
  "success": true,
  "message": "Tags added successfully: ecomdrop-processed",
  "orderId": "gid://shopify/Order/5678901234567890",
  "tags": ["ecomdrop-processed"]
}
If no tags are explicitly provided, the endpoint will use a default tag based on the status field, or “ecomdrop-processed” if no status is provided.
This endpoint searches for orders using Shopify’s GraphQL API, which requires app approval for protected customer data. The endpoint will return a 403 error until the app is published and approved by Shopify.

​
Tag Priority

Tags are applied in the following priority order:
  1. Explicit tag or tags parameters
  2. Auto-mapped tags from status field
  3. Default tag: “ecomdrop-processed”

​
Authentication

The endpoint authenticates requests using the apiKey parameter, which must match an Ecomdrop API key stored in the database. The shop is identified automatically based on the API key.

Build docs developers (and LLMs) love

Get started for freeTalk to us