Conventions

Schemas

All data is sent and received as JSON objects.

Field Formats

Fields are named in lowercase and in snake case (ex: my_parameter).

Type	Format	Example
integer	number	`{"field_name": 234}`
float	number	`{"field_name": 234.56}`
string	string	`{"field_name": "text"}`
boolean	json boolean	`{"field_name": true}`
null	json null	`{"field_name": null}`
datetime	ISO-8601	`{"field_name": "2016-10-03T12:34:56+01:00"}`
uuid	base57 (shortuuid)	`{"field_name": "UNDTMBovdue9tFWfhamnDM"}`

Datetime Formats

Datetime fields use ISO-8601 format: YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|Z]

{"date": "2016-10-03"}
{"time": "12:34:56"}
{"datetime": "2016-10-03T12:34:56"}
{"datetime_tz": "2016-10-03T12:34:56+01:00"}
{"datetime_micro": "2016-10-03T12:34:56.123"}

Parameters

Many API methods take optional parameters. For GET and DELETE requests, any parameters not specified as a segment in the path can be passed as an HTTP query string parameter.

For POST and PUT requests, parameters not included in the URL should be encoded as JSON with a Content-Type of application/json.

The formatting used is the same as for fields.

Server Hosts

Production environments currently operate from the application hostname:

LucidSource: https://source.lucidgreen.io
LucidRetail: https://retail.lucidgreen.io

Testing environments are available, and will be provided for all integrations:

LucidSource: https://source-test.lucidgreen.io
LucidRetail: https://retail-test.lucidgreen.io

Test environments may become unusable or unavailable from time to time as they are upgraded and new services are tested. If you have any issues with connectivity, please contact us using the instructions provided in Contact and Support.