GXOrderItem resource

Methods

  • post - Create Order Item
  • get - Get Order Item (Single)
  • get - Get Order Items (Multiple)
  • put - Update Order Item

Properties

{
    "addonValues": {
        "productId": "string",
        "productType": "string"
    },
    "attributes": {
        "combisId": "int64",
        "id": "int64",
        "name": "string",
        "optionId": "int64",
        "optionValueId": "int64",
        "price": "int64",
        "priceType": "string",
        "value": "string"
    },
    "checkoutInformation": "string",
    "customizationData": {},
    "discount": "int64",
    "downloadInformation": [
        "string"
    ],
    "finalPrice": "int64",
    "gxCustomizerData": [
        "string"
    ],
    "id": "int64",
    "isTaxAllowed": "boolean",
    "model": "string",
    "name": "string",
    "price": "int64",
    "quantity": "int64",
    "quantityUnitName": "string",
    "shippingTimeInformation": "string",
    "tax": "int64"
}
{
    "addonValues": {
        "productId": "2",
        "quantityUnitId": "1"
    },
    "attributes": [
        {
            "combisId": null,
            "id": 1,
            "name": "Farbe",
            "optionId": 1,
            "optionValueId": 1,
            "price": 0,
            "priceType": "+",
            "value": "rot"
        }
    ],
    "checkoutInformation": "Checkout information goes here ...",
    "customizationData": {
        "areas": [
            {
                "areaId": 1,
                "elements": [
                    {
                        "elementId": 1,
                        "file": "",
                        "name": "Name1",
                        "type": "text_input",
                        "value": "Value"
                    }
                ],
                "name": "Area1"
            }
        ],
        "setId": 1,
        "setName": "Set1"
    },
    "discount": 0,
    "downloadInformation": {
        "countAvailable": 14,
        "filename": "Dokument.pdf",
        "maxDaysAllowed": 5
    },
    "finalPrice": 11,
    "isTaxAllowed": true,
    "model": "12345-s-black",
    "name": "Ein Artikel",
    "price": 11,
    "quantity": 1,
    "quantityUnitName": "Liter",
    "shippingTimeInformation": "",
    "tax": 19
}
Name Type Description Additional
addonValues object GXOrderItemsAddons Required
addonValues.productId string Required
addonValues.productType string Required
attributes object GXOrderItemAttributes Required
attributes.combisId int64 Required
attributes.id int64 Optional , read only.
attributes.name string Required
attributes.optionId int64 Required
attributes.optionValueId int64 Required
attributes.price int64 Required
attributes.priceType string Required
attributes.value string Required
checkoutInformation string Required
customizationData object Optional
discount int64 Required
downloadInformation[] array of string Required
finalPrice int64 Required
gxCustomizerData[] array of string Required
id int64 Optional , read only.
isTaxAllowed boolean Required
model string Required
name string Required
price int64 Required
quantity int64 Required
quantityUnitName string Required
shippingTimeInformation string Required
tax int64 Required