Examples
Order
Below is an example of the most simple solution for an order. In both instances, a composed product is used. It is possible to change the products used, by checking our other examples. For the delivery presets are used, but here it is also possible to set your delivery preferences.
Example Composed Product + Fixed file.
{
"order_type": "test",
"error_email_addresses": [
"${order.error.email}"
],
"callback_url": [
"${order.webhook}"
],
"id": "${order.id}",
"reference": "${order.reference}",
"contact_email": "${order.contact_email}",
"deliveries": [
{
"address": {
"company_name": "${delivery.company}",
"first_name": "${delivery.firstname}",
"last_name": "${delivery.lastname}",
"street": "${delivery.address.street}",
"house_number": "${delivery.address.house_number}",
"addition": "${delivery.address.addition}",
"postal_code": "${delivery.address.postalcode}",
"city": "${delivery.address.city}",
"country": "${delivery.address.country}",
"phone": "${delivery.address.phone}",
"email": "${delivery.address.email}"
},
"delivery_date_preset": "cheapest",
"shipping_method_preset": "cheapest"
}
],
"products": [
{
"customer_code": "forex-ds-direct-3mm-cut",
"files": [
{
"uri": "https://www.dropbox.com/s/p2ye6w9j1a012tc/Awesome%20Wandkleed.jpg?dl=1",
"fill": true
}
]
}
]
}
Auto uploader generation is deprecated as of 31st September
The automatic generation of uploaders will be deprecated. Please generate the uploaders via the API before placing the order.
Example Composed Product + Uploader (DEPRECATING)
{
"order_type": "test",
"error_email_addresses": [
"${order.error.email}"
],
"callback_url": [
"${order.webhook}"
],
"id": "${order.id}",
"reference": "${order.reference}",
"contact_email": "${order.contact_email}",
"deliveries": [
{
"address": {
"company_name": "${delivery.company}",
"first_name": "${delivery.firstname}",
"last_name": "${delivery.lastname}",
"street": "${delivery.address.street}",
"house_number": "${delivery.address.house_number}",
"addition": "${delivery.address.addition}",
"postal_code": "${delivery.address.postalcode}",
"city": "${delivery.address.city}",
"country": "${delivery.address.country}",
"phone": "${delivery.address.phone}",
"email": "${delivery.address.email}"
},
"delivery_date_preset": "cheapest",
"shipping_method_preset": "cheapest"
}
],
"products": [
{
"customer_code": "forex-ds-direct-3mm-cut",
"uploader": true
}
]
}
Example with product configuration and a pre-created uploader session
{
"order_type": "test",
"error_email_addresses": [
"${order.error.email}"
],
"callback_url": [
"${order.webhook}"
],
"id": "${order.id}",
"reference": "${order.reference}",
"contact_email": "${order.contact_email}",
"deliveries": [
{
"address": {
"company_name": "${delivery.company}",
"first_name": "${delivery.firstname}",
"last_name": "${delivery.lastname}",
"street": "${delivery.address.street}",
"house_number": "${delivery.address.house_number}",
"addition": "${delivery.address.addition}",
"postal_code": "${delivery.address.postalcode}",
"city": "${delivery.address.city}",
"country": "${delivery.address.country}",
"phone": "${delivery.address.phone}",
"email": "${delivery.address.email}"
},
"delivery_date_preset": "cheapest",
"shipping_method_preset": "cheapest"
}
],
"products": [
{
"code": "banner-510",
"options": [
{
"code": "width",
"value": 100
},
{
"code": "height",
"value": 100
},
{
"code": "amount",
"value": 1
},
{
"code": "finishing-all-sides"
},
{
"code": "cut"
}
],
"uploaders": [
{
"id": 123456,
"external_id": 654321
}
]
}
]
}
Example with a sender address, 2 product configurations, and a pre-created uploader session
{
"order_type": "test",
"error_email_addresses": [
"${order.error.email}"
],
"callback_url": [
"${order.webhook}"
],
"id": "${order.id}",
"reference": "${order.reference}",
"contact_email": "${order.contact_email}",
"deliveries": [
{
"address": {
"company_name": "${delivery.company}",
"first_name": "${delivery.firstname}",
"last_name": "${delivery.lastname}",
"street": "${delivery.address.street}",
"house_number": "${delivery.address.house_number}",
"addition": "${delivery.address.addition}",
"postal_code": "${delivery.address.postalcode}",
"city": "${delivery.address.city}",
"country": "${delivery.address.country}",
"phone": "${delivery.address.phone}",
"email": "${delivery.address.email}"
},
"sender_address": {
"company_name": "${sender.company}",
"first_name": "${sender.firstname}",
"last_name": "${sender.lastname}",
"street": "${sender.address.street}",
"house_number": "${sender.address.house_number}",
"addition": "${sender.address.addition}",
"postal_code": "${sender.address.postalcode}",
"city": "${sender.address.city}",
"country": "${sender.address.country}"
},
"delivery_date": "2027-03-28",
"shipping_method_preset": "onb-standard"
}
],
"products": [
{
"code": "banner-510",
"options": [
{
"code": "width",
"value": 100
},
{
"code": "height",
"value": 100
},
{
"code": "amount",
"value": 1
},
{
"code": "finishing-all-sides"
},
{
"code": "cut"
}
],
"uploaders": [
{
"id": 123456,
"external_id": 654321
}
]
},
{
"code": "2024-wall-circle",
"options": [
{
"code": "width",
"value": 40
},
{
"code": "height",
"value": 40
},
{
"code": "amount",
"value": 5
},
{
"code": "sh-m-forex-bl-3-printed"
},
{
"code": "1-layer-neon-2-layers-white-backside"
},
{
"code": "spot-color"
},
{
"code": "standard"
}
],
"uploaders": [
{
"id": 987456,
"external_id": 123457
}
]
}
]
}