Explore APIs using RAML, OAS, GraphQL, and UML files.
The API specifications are available on GitHub. They are free to use and updated when changes are made to the APIs.
You can use these specifications to create tools such as:
- Code generators to build client libraries in different languages
- Validators to check that requests and responses match the API contract
- Mock servers to test and prototype without a live project
- Custom extensions to enhance SDKs, IDEs, or other developer tools
- Automation scripts to run bulk data imports or testing tasks
Using these specifications helps you integrate faster, reduce errors, and stay compatible with APIs.
APIs are described in two formats: RAML (RESTful API Modeling Language) and OAS (OpenAPI Specification).
API specifications for Connect are not available in OAS.
| API | Specifications |
|---|---|
| HTTP API | RAML, OAS |
| Import | RAML, OAS |
| Audit Log | RAML, OAS |
| Checkout | RAML, OAS |
| Connect | RAML |
GraphQL schema
The schema for our GraphQL API is available on GitHub.
UML diagrams
UML (Unified Modeling Language) diagrams help you visualize the structure, relationships, and data flow of an API, making it easier to understand and work with complex systems.
Diagrams for the HTTP API are available on GitHub.