The Three APIs
Each API targets a different use case. Most integrations use one of the first two; SCX is specific to marketplace integrations.| API | What it’s for | Protocol |
|---|---|---|
| REST API | Transactional operations on merchant data (orders, items, customers, stock) | REST over HTTP |
| GraphQL API | Flexible queries over the same ERP domain, fetching exactly the fields you need | GraphQL |
| SCX API | OnPremise marketplace channel integrations (e.g., Amazon, eBay). See Marketplace Channels for channel-specific integration detail. | REST over HTTP |
Common Conventions
Both ERP APIs target version2.0 of the API and include authentication headers described in Integration Overview. They differ in pagination shape:
- REST uses page-based pagination with
pageNumberandpageSizequery parameters, returning a wrapped envelope withitems[]and page metadata - GraphQL uses cursor-based pagination with
firstandaftervariables, returningnodes[]and apageInfoobject
Next Steps
GraphQL Playground
Try queries and mutations interactively against your ERP instance.
REST API Reference
Browse all REST API endpoints with request/response schemas.
Integration Overview
Base URLs, authentication, and required headers.
Pagination
The full page-based pagination contract.