Get Ware

Returns the details of a single ware.

Request

GET /api/oauth/v2/resource/wares/{uuid}

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string	Yes	Unique ID of the ware

Response

Success (200 OK)

The response has the same field structure as a row of List Wares — including the stock block, which is only present when the Stock management add-on is licensed.

Note: An archived or deleted ware still returns 200 — archived or deleted is true then. Only a purely virtual ware returns 404.

{
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-012345678901",
    "name": "Kompressionsstrumpf Klasse II",
    "description": "Paar, Größe M",
    "number": "1004",
    "internalNumber": "KS-M-002",
    "type": "ware",
    "price": 39.90,
    "vat": 20,
    "color": "#00adba",
    "sellable": true,
    "deliverable": true,
    "invoiceSortIndex": 0,
    "archived": false,
    "deleted": false,
    "category": "d4e5f6a7-b8c9-0123-defa-123456789012",
    "groups": [{ "name": "Verbandsmaterial" }],
    "storages": ["f6a7b8c9-d0e1-2345-fabc-345678901234"],
    "distributors": ["a7b8c9d0-e1f2-3456-abcd-456789012345"],
    "tenancies": ["f0e1d2c3-b4a5-6789-fedc-ba9876543210"],
    "stock": {
      "stockEffective": 24,
      "stockAvailable": 20,
      "stockMinimum": 10,
      "stockTarget": 30,
      "purchasingPriceNet": 18.50,
      "sellingPriceNet": 33.25,
      "unit": "pcs",
      "unitBase": 1,
      "unitBaseSign": false,
      "deliveryNotice": null,
      "storageNotice": null,
      "distributorNotice": null
    }
  }
}

Response fields

See List Wares for the full field reference — the data object here has the same fields as one entry of data[] there.

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/wares/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *string

Zuerst Token anfordern

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope wares not present
404	not_found	Ware not found or purely virtual