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:
| Convention | Description | Example |
|---|---|---|
| Currency | Represent monetary values in US Dollars (USD) | 100.00 |
| Date and Time | Adhere to ISO 8601 standard format | 2024-07-31T14:30:00Z |
| Dimensions | Express height, width and length measurements in inches (in) | 80 |
| Distance | Express distance measurements in miles (mi) | 1200 |
| Temperature | Express temperature measurements in Fahrenheit | 72 |
| Weight | Express weight measurements in pounds (lb) | 42000 |