API reference navigation

Orders

Admin

Orders groups 5 operations on the admin tier.

Admin tier. Requires an RBAC-gated vnstat_ access token, sent as Authorization: Bearer … or X-Vinosoft-Access-Token.

GET

/api/{version}/admin/orders

Not implemented

This route is declared in the spec but not implemented yet — it answers 501.

Not implemented; always 501.

AuthenticationToken requiredAdmin tier. Requires an RBAC-gated vnstat_ access token, sent as Authorization: Bearer … or X-Vinosoft-Access-Token.

Responses

501ApiErrorResponseNot Implemented

curl -X GET \
  'https://<your-shop-domain>/api/2026-04-01/admin/orders' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer vnstat_<token>'

POST

/api/{version}/admin/orders

Not implemented

This route is declared in the spec but not implemented yet — it answers 501.

Not implemented; always 501 and nothing is created.

AuthenticationToken requiredAdmin tier. Requires an RBAC-gated vnstat_ access token, sent as Authorization: Bearer … or X-Vinosoft-Access-Token.

Responses

501ApiErrorResponseNot Implemented

curl -X POST \
  'https://<your-shop-domain>/api/2026-04-01/admin/orders' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer vnstat_<token>'

GET

/api/{version}/admin/orders/{id}

Not implemented

This route is declared in the spec but not implemented yet — it answers 501.

Not implemented; always 501, including for an id that exists.

AuthenticationToken requiredAdmin tier. Requires an RBAC-gated vnstat_ access token, sent as Authorization: Bearer … or X-Vinosoft-Access-Token.

Path parameters

Name	Type	Description
id required	string (uuid)

Responses

501ApiErrorResponseNot Implemented

curl -X GET \
  'https://<your-shop-domain>/api/2026-04-01/admin/orders/<id>' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer vnstat_<token>'

PUT

/api/{version}/admin/orders/{id}

Not implemented

This route is declared in the spec but not implemented yet — it answers 501.

Not implemented; always 501 and nothing is modified.

AuthenticationToken requiredAdmin tier. Requires an RBAC-gated vnstat_ access token, sent as Authorization: Bearer … or X-Vinosoft-Access-Token.

Path parameters

Name	Type	Description
id required	string (uuid)

Responses

501ApiErrorResponseNot Implemented

curl -X PUT \
  'https://<your-shop-domain>/api/2026-04-01/admin/orders/<id>' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer vnstat_<token>'

DELETE

/api/{version}/admin/orders/{id}

Not implemented

This route is declared in the spec but not implemented yet — it answers 501.

Not implemented; always 501 and nothing is deleted.

AuthenticationToken requiredAdmin tier. Requires an RBAC-gated vnstat_ access token, sent as Authorization: Bearer … or X-Vinosoft-Access-Token.

Path parameters

Name	Type	Description
id required	string (uuid)

Responses

501ApiErrorResponseNot Implemented

curl -X DELETE \
  'https://<your-shop-domain>/api/2026-04-01/admin/orders/<id>' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer vnstat_<token>'

Schemas

ApiErrorResponse

The error envelope every non-2xx response from this API uses. Documentation shape: actions build it as an anonymous object, so this type exists to give the OpenAPI document a schema to point at.

errorsstringnullable
Human-readable description of what went wrong, e.g. Not Found, Invalid page_info.
codestringnullable
Machine-readable error code. Only a few endpoints (checkout) emit one; omitted everywhere else.