Integrations

Integrations

Integrations connect e-commerce platforms (Shopify, Amazon, WooCommerce, etc.) to your WMS, enabling bidirectional data synchronization.

List Integrations

GET /api/2.0/app/integrations
Authorization: Bearer YOUR_TOKEN

Response:

{
  "data": [
    {
      "id": 42,
      "name": "My Shopify Store",
      "service_id": 5,
      "service": {
        "name": "Shopify",
        "type": "SHOPIFYV2"
      },
      "configuration": {
        "shop": "mystore.myshopify.com",
        "filter": {}
      },
      "gateway_key": "gw_abc123xyz",
      "status": "ACTIVE",
      "created_at": "2024-01-15T10:30:00.000000Z"
    }
  ]
}

Get Integration

GET /api/2.0/app/integrations/{id}
Authorization: Bearer YOUR_TOKEN

Execute Action

Run integration resources (get_orders, update_tracking, sync_inventory):

POST /api/2.0/app/integrations/{id}/action
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "resource": "get_orders",
  "params": {
    "order_status": ["open"],
    "date": "2024-01-15",
    "acknowledged": false
  }
}

Available Resources:

• get_orders - Import orders
• update_tracking - Send tracking updates
• sync_inventory - Sync inventory levels
• get_products - Import products
• acknowledge_orders - Mark orders as acknowledged

Claim Integration

Assign integration to an account:

POST /api/2.0/app/integrations/{id}/claim
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "account_remote_id": "myapp_tenant_12345"
}

Update Integration

PUT /api/2.0/app/integrations/{id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "configuration": {
    "shop": "newstore.myshopify.com",
    "filter": { "order_status": ["open", "closed"] }
  }
}

Update Status

PATCH /api/2.0/app/integrations/{gateway_key}/status
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "status": "INACTIVE"
}

Statuses: ACTIVE, INACTIVE

Delete Integration

DELETE /api/2.0/app/integrations/{id}
Authorization: Bearer YOUR_TOKEN

View complete integration development guide →