HTTP methods
The API Reference and the guides use the same color for each HTTP method, in light and dark mode, so you can tell what a call does at a glance.
| Method | Meaning | Examples in the Cargo API |
|---|---|---|
| GET | Reads data. Safe to repeat, never changes anything. | /v3/order/list, /picking-point/view/{id} |
| POST | Creates a resource or runs an action. | /v3/order-create, /v3/order-cancel, /user/create |
| PUT | Updates an existing resource. | /picking-point, /user/update |
| PATCH | Partially updates a resource. Not used by the public API today. | none yet |
| DELETE | Removes a resource. | /picking-point |
POST is not always "create"
Some read-only calls are POST because they take a request body, for example
/v3/order-status and /v3/order-validate, and user deletion is POST /user/delete, not DELETE. Check the operation's description in the
API Reference rather than relying on the verb alone.
Response status codes follow the same idea: 2xx
success, 4xx / 5xx error. See
Authentication for the 401 case.