/api/order29
Single order with positions (incl. deposit/Pfand snapshot), subscriptions, and optional item data
Change Note: Position now carries the per-position deposit snapshot (refund, refundvat frozen at order time; refundname resolved live from the frozen refundid)
Parameters
| Name | Description | Type |
|---|---|---|
| oid | order identifier (order id) | string |
| items | set to 1 to include item data, tour limits and xunits | int |
| oo-rf | optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml | String |
| oo-auth | optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. | int |
Response Types
| Type | Version | Description |
|---|---|---|
| Order | 12 | A customer order with delivery, status, and invoice information |
| Assorted | 1 | Unresolved assortment subscription detail for an order |
| PermanentPosition | 1 | A permanent (standing) order position from a subscription |
| Position | 3 | An order line item position with deposit (Pfand) snapshot |
| Item | 25 | A warehouse Item |
| TourLimit | 2 | Item order limits applicable for individual tours |
| RelatedItem | 2 | Items may have relations to other items (like recommended additions or as ingredient) |
| B2BInfo | 1 | Wholesale (B2B) net price and packaging option for an item. May occur multiple times per item, one per pick option. Exists only in B2B systems. |
| XUnit | 5 | Alternative Units |
OpenAPI
See order29.yaml