Stability and changes
The spec is the contract between your software and Shirtee. We evolve it additively.
What you can expect
Section titled “What you can expect”- New endpoints, new fields in responses and new optional parameters can appear at any time.
- We do not change existing fields, paths and response codes silently. A change that could break existing integrations arrives first on a new path. The old path stays until the switch is announced and complete.
- What changed is listed in the changelog.
How to protect yourself
Section titled “How to protect yourself”- Ignore unknown fields in responses. A new field must not crash your software.
- Evaluate
extra.error, notdetail. Message texts can change, the codes stay. - Read enum values tolerantly. A list of status values can grow. Treat unknown values as “keep watching”, not as an error.
- Do not depend on order. The order of fields in JSON is not defined.