Opter TextEDI API and JSON schemas
Documentation, API definitions, JSON schemas and example files for partners integrating with Opter.
Documentation and API definition
Start with the integration guide, then use the API definition or the Postman collection to test calls.
-
Integration guide (PDF, v1.3)
How to connect to and use the TextEDI API.
Opter_TextEDI_API_Integration_Guide_externalForPartners_v1_3.pdf Open PDF -
API definition (YAML)
Endpoints and message formats for the TextEDI API.
OpterTextEdi.yaml Open YAML -
Postman collection
Import into Postman to try the API requests.
Opter_TextEDI_API_postman_collection.json Open collection
JSON schemas
Use these to validate the messages you send and receive.
Order booking examples
Sample orders that validate against the order booking schema, from the smallest valid booking to a full order.
-
Minimal booking
Only the fields needed for a valid booking.
opterOrderBookingjsonSchema1.0-minimalbookingSample.json Open example -
Compact order
A typical order with the most common fields.
opterOrderBookingJsonSchema1.0-orderCompactSample.json Open example -
Full order
An order showing the broader set of available fields.
opterOrderBookingJsonSchema1.0-orderSample.json Open example