Skip to main content

Conventions

Our API adheres to RESTful principles and is documented using the OpenAPI3 specification. You can access the specification here for detailed information about endpoints, parameters, and expected responses. In addition to this reference, you can access it raw.

Unless otherwise noted on the specification, our APIs follow the following conventions:

ConventionDescriptionExample
CurrencyRepresent monetary values in US Dollars (USD)100.00
Date and TimeAdhere to ISO 8601 standard format2024-07-31T14:30:00Z
DimensionsExpress height, width and length measurements in inches (in)80
DistanceExpress distance measurements in miles (mi)1200
TemperatureExpress temperature measurements in Fahrenheit72
WeightExpress weight measurements in pounds (lb)42000