Endpoints Reference

Endpoints Reference

Complete reference for all Gateway API endpoints organized by version and endpoint group.

Quick Navigation

• v2.0 USER Endpoints - User & OAuth client management
• v2.0 APP Endpoints - Application-level operations
• v2.0 WEBCOMPONENT Endpoints - Account-scoped operations
• v1.0 Endpoints - Legacy endpoints

---

v2.0 USER Endpoints

Base Path: /api/2.0/user/*

Authentication: Password Grant OAuth2 (auth:api)

Purpose: User management and OAuth client administration

OAuth Clients

Method	Endpoint	Description	Scopes/Permissions
GET	/user/clients	List OAuth clients	permission:read-client
GET	/user/clients/{id}	Get OAuth client	permission:read-client
POST	/user/clients	Create OAuth client	permission:create-client
PUT	/user/clients/{id}	Update OAuth client	permission:update-client
DELETE	/user/clients/{id}	Delete OAuth client	permission:delete-client

Apps

Method	Endpoint	Description
GET	/user/apps	List user’s apps
GET	/user/apps/{appId}	Get app details
POST	/user/apps	Create new app
PUT	/user/apps/{appId}	Update app
DELETE	/user/apps/{appId}	Delete app
POST	/user/apps/{appId}/logo	Upload app logo

App Services

Method	Endpoint	Description
GET	/user/apps/{appId}/services	List app services
POST	/user/apps/{appId}/services	Attach service to app
PUT	/user/apps/{appId}/services/{serviceId}	Update service
DELETE	/user/apps/{appId}/services/{serviceId}	Detach service
PUT	/user/apps/{appId}/services-sync	Sync services
POST	/user/apps/{appId}/services/{serviceId}/logo	Upload service logo

App Integrations

Method	Endpoint	Description
GET	/user/apps/{appId}/integrations	List app integrations
GET	/user/apps/{appId}/integrations/{integrationId}	Get integration
POST	/user/apps/{appId}/integrations/{integrationId}/claim	Claim integration

---

v2.0 APP Endpoints

Base Path: /api/2.0/app/*

Authentication: Client Credentials Grant (client_credentials + auth.app)

Purpose: Application-level integration management

Intents

Method	Endpoint	Description	Required Scope
POST	/app/intent/{account:remote_id}	Create intent token	app:intent-create

Example:

curl -X POST https://<GATEWAY_URL>/api/2.0/app/intent/ACCT123 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"scopes": ["webcomponent:integration-read"]}'

Accounts

Method	Endpoint	Description	Required Scope
GET	/app/accounts	List accounts	app:account-read
GET	/app/accounts/{account:remote_id}	Get account	app:account-read
POST	/app/accounts	Create account	app:account-create
PUT	/app/accounts/{accountId}	Update account	app:account-update

Example:

curl -X GET https://<GATEWAY_URL>/api/2.0/app/accounts \
  -H "Authorization: Bearer YOUR_TOKEN"

Integrations

Method	Endpoint	Description	Required Scope
GET	/app/integrations	List integrations	app:integration-read
GET	/app/integrations/{integration}	Get integration	app:integration-read
POST	/app/integrations/{integrationId}/action	Execute action	app:integration-action
PUT	/app/integrations/{integrationId}	Update integration	app:integration-update
DELETE	/app/integrations/{integrationId}	Delete integration	app:integration-delete
POST	/app/{resource}/install	Install integration	app:integration-create
POST	/app/integrations/{integrationId}/claim	Claim integration	app:integration-claim
PATCH	/app/integrations/{integrationKey}/status	Update status	app:integration-update

Run Action Example:

curl -X POST https://<GATEWAY_URL>/api/2.0/app/integrations/42/action \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "get_orders",
    "params": {
      "order_status": ["open"],
      "date": "2024-01-15"
    }
  }'

Services

Method	Endpoint	Description	Required Scope
GET	/app/services	List available services	app:service-attach
GET	/app/services/{service}	Get service details	app:service-attach

Flows

Method	Endpoint	Description	Required Scope
GET	/app/flows	List flows	app:flow-read
GET	/app/flows/{flow}	Get flow details	app:flow-read

---

v2.0 WEBCOMPONENT Endpoints

Base Path: /api/2.0/webcomponent/*

Authentication: Account-based token (auth.account:webcomponent:*)

Purpose: Account-scoped operations for embedded components

App Information

Method	Endpoint	Description	Required Scope
GET	/webcomponent/app	Get current app	webcomponent:app-read

Integrations

Method	Endpoint	Description	Required Scope
GET	/webcomponent/integrations	List account integrations	webcomponent:integration-read
GET	/webcomponent/integrations/{integrationId}	Get integration	webcomponent:integration-read
PUT	/webcomponent/integrations/{integrationId}	Update integration	webcomponent:integration-update
POST	/webcomponent/integrations/{integrationId}/event	Run event	webcomponent:integration-event
POST	/webcomponent/integrations/{integrationId}/logo	Upload logo	webcomponent:integration-read

Integration Management

Method	Endpoint	Description	Required Scope
POST	/webcomponent/service/{resource}/install	Install integration	webcomponent:integration-create
POST	/webcomponent/integrations/{integrationId}/install	Complete installation	webcomponent:integration-install
POST	/webcomponent/integrations/{integrationId}/uninstall	Uninstall integration	webcomponent:integration-install
POST	/webcomponent/integrations/{integrationId}/actions	Execute action	webcomponent:integration-event

Schedules

Method	Endpoint	Description	Required Scope
POST	/webcomponent/integrations/{integrationId}/schedule	Create schedule	webcomponent:integration-schedule
PUT	/webcomponent/integrations/{integrationId}/schedule/{scheduleId}	Update schedule	webcomponent:integration-schedule
DELETE	/webcomponent/integrations/{integrationId}/schedule/{scheduleId}	Delete schedule	webcomponent:integration-schedule

Logs & Services

Method	Endpoint	Description	Required Scope
GET	/webcomponent/integrations/{integrationId}/logs	Get integration logs	webcomponent:integration-read
GET	/webcomponent/services	List available services	webcomponent:integration-read
GET	/webcomponent/services-type/{serviceType}	Get service by type	webcomponent:integration-read

---

v1.0 Endpoints (Legacy)

Base Path: /api/1.0/*

Authentication: Password Grant OAuth2 (auth:api)

[!WARNING] These endpoints are legacy and maintained for backwards compatibility. Use v2.0 for all new integrations.

Users

Method	Endpoint	Permission	Description
GET	/users	read-user	List users
GET	/users/{user}	read-user	Get user
GET	/users/information	-	Get current user info
POST	/users	create-user	Create user
PUT	/users/{user}	update-user	Update user
DELETE	/users/{user}	delete-user	Delete user

Integrations

Method	Endpoint	Permission	Description
GET	/integrations	read-integration	List integrations
GET	/integrations/{integration}	read-integration	Get integration
POST	/integrations	create-integration	Create integration
PUT	/integrations/{integration}	update-integration	Update integration
DELETE	/integrations/{integration}	delete-integration	Delete integration
POST	/{resource}/install	read-integration	Install integration

Services

Method	Endpoint	Permission	Description
GET	/services	read-integration	List services
GET	/services/{service}	read-integration	Get service
GET	/services/logos	read-integration	Get all logos
POST	/services	create-integration	Create service
PUT	/services/{service}	update-service	Update service
DELETE	/services/{service}	delete-service	Delete service
POST	/services/{service}/logo	create-integration	Upload logo

Schedules

Method	Endpoint	Permission	Description
GET	/schedules	read-schedule	List schedules
GET	/schedules/{schedule}	read-schedule	Get schedule
POST	/schedules	create-schedule	Create schedule
PUT	/schedules/{schedule}	update-schedule	Update schedule
DELETE	/schedules/{schedule}	delete-schedule	Delete schedule

Bulk Schedule Operations

Method	Endpoint	Permission	Description
POST	/schedules-bulk	create-schedule	Create multiple schedules
PUT	/schedules-bulk	update-schedule	Update multiple schedules
DELETE	/schedules-bulk	delete-schedule	Delete multiple schedules

Apps, Accounts, Companies

Method	Endpoint	Description
GET	/apps	List apps
GET	/apps/{app}	Get app
POST	/apps	Create app
PUT	/apps/{app}	Update app
DELETE	/apps/{app}	Delete app
GET	/accounts	List accounts
GET	/accounts/{account}	Get account
POST	/accounts	Create account
PUT	/accounts/{account}	Update account
DELETE	/accounts/{account}	Delete account
GET	/companies	List companies
GET	/companies/{company}	Get company
POST	/companies	Create company
PUT	/companies/{company}	Update company

---

Gateway-Scoped Endpoints (v1.0 with Gateway Key)

Base Path: /api/1.0/*

Authentication: Password Grant + verified.gateway.key middleware

Purpose: Integration-specific operations requiring gateway key verification

Orders

Method	Endpoint	Permission	Description
GET	/orders	-	List orders
GET	/orders/{order}	read-order	Get order
POST	/orders	create-order	Create order
PUT	/orders/{order}	update-order	Update order
DELETE	/orders/{order}	delete-order	Delete order
POST	/orders/acknowledge	-	Acknowledge orders
PUT	/orders/{order}/cancel	-	Cancel order
GET	/sandbox/orders	-	List sandbox orders

Shipments

Method	Endpoint	Description
POST	/shipments	Create shipment/tracking update

Inventory

Method	Endpoint	Description
POST	/inventory	Sync inventory levels

Products

Method	Endpoint	Description
GET	/products	List products
POST	/export-products	Export products to cart

Webhooks

Method	Endpoint	Description
POST	/webhooks	Create webhook
DELETE	/webhooks/{webhookId}	Delete webhook

Resources & Actions

Method	Endpoint	Description
GET	/resource/{resource}	Get resource data
POST	/services-request	Execute service request

---

Public Endpoints (No Authentication)

OAuth2 Installation & Callbacks

Method	Endpoint	Description
GET	/app_authorization/{channel}	OAuth2 authorization redirect
GET	/app_callback/{channel}	OAuth2 callback handler
GET	/webhook_callback/{channel}/{account_id}/{store}	Webhook callback

OAuth2 Token

Method	Endpoint	Description
POST	/oauth/token	Obtain access token

Supported Grant Types:

• password - User authentication
• client_credentials - App authentication
• refresh_token - Token refresh

---

Common Query Parameters

Pagination

All list endpoints support pagination:

?page=1&per_page=15

• page - Page number (default: 1)
• per_page - Items per page (default: 15, max: 100)

Filtering

Some endpoints support filtering:

?status=ACTIVE&service_id=5

Sorting

Where supported:

?sort=-created_at

• field - Ascending
• -field - Des cending

Including Related Data

Some endpoints support eager loading:

?include=service,schedules,logs

---

Response Codes

All endpoints follow standard HTTP status codes:

Code	Meaning	When Used
200	OK	Successful GET, PUT, PATCH
201	Created	Successful POST
204	No Content	Successful DELETE
400	Bad Request	Malformed request
401	Unauthorized	Missing/invalid token
403	Forbidden	Insufficient permissions
404	Not Found	Resource doesn’t exist
422	Validation Error	Invalid data
429	Rate Limited	Too many requests
500	Server Error	Internal server error

---

Testing Endpoints

Use the interactive Swagger documentation to explore and test endpoints:

Open Swagger UI →

Features:

• 🧪 Test endpoints with real requests
• 📋 View complete request/response schemas
• 🔐 Authenticate once, test all endpoints
• 📚 Comprehensive parameter documentation

---

Next Steps

• Learn about specific functions
• View authentication methods
• Understand API versioning
• Make your first request