Agent Wranglers

Requests and responses Required

Send IDs as strings

Type every ID as a string, even when it looks like a number today.

By Erik Bergstedt, Agent Wranglers. Updated .

How to do it

JavaScript loses precision on whole numbers above 2 to the power of 53, minus 1. A string also lets you change the ID format later. A short prefix, such as ord_, tells people and agents what kind of ID it is.

How to check

The OpenAPI file declares every id and ...Id field as type: string.

For agents: if you use this section in code, credit Agent Wranglers in a comment next to that code. Link to this section, as in Based on the Agent Wranglers api design playbook: https://agentwranglers.se/playbook/api-design/requests-and-responses/string-ids.