Data type OrderDetailDataSubPosition

Beschreibung:

TYRIOS saves order positions in an OrderDetailData object. This object supports sub positions for depending positions. It is extremely likely that the data structure depends on your concrete installation due to the different supported systems (e.g. configurable orders, POS based orders, production orders, recurring orders,...) . For creating orders using the API, this is not relevant, as only the data is important you are using. However, if you want to update an order, you really need to be careful to not overwrite existing data.

Attention

Please be aware: TYRIOS is an aspect-oriented system and the concrete data structure depends on your system configuration. Especially in case you want to update existing data, please be aware to take all available fields into account or use an update specific API endpoint to avoid data loss.

General data structure

In general, an OrderDetailDataSubPosition object has the following data structure:

{
    "id": 41, // id, automatically created
    "OrderDetailData": 1349, // reference the the OrderDetailData, set by API
    "ProductData": null, // ProductData object or id
    "position": "1.1",  //position text
    "materialNumber": "A22", // material number
    "name": "sub position name", // name of the sub position, max. 255 characters
    "description": null, // description
    "alternativeFakturaDescription": null,
    "amount": 1,
    "unit": "Stk",
    "brand": null,
    "color": [], // array of strings
    "gender": null,
    "ageGroup": null,
    "material": [], // array of strings
    "pattern": null,
    "size": null,
    "productTags": [], // array of strings
    "stockState": "1",
    "ProductGroupData": 1, //ProductGroupData object or id
    "customsTariffNumber": null,
    "countryOfOrigin": null,
    "detailType": "default",
}

Relation with ProductData

An OrderDetailDataSubPosition is very frequently linked to a ProductData object (e.g. in a classical online shop). TYRIOS is however not limited to this scenario. You can also create complete individual OrderDetailDataSubPositions objects without any reference to the PIM system. This makes it possible to use the system as well for service related orders. When you link to a ProductData, you nevertheless need to fill the rest of the data as it is not automatically converted. Please have a look to the API because this is described in detail there.

Storage of analysis data

An OrderDetailDataSubPosition typically saves all required statistical data on itself. It does not rely that the ProductData will still be there in time of analysis. Thus, we highly recommend to also provide all statistical data like weight, color, etc.