{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Message info",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Message ID"
},
"type": {
"type": "string",
"description": "Message type"
},
"version": {
"type": "string",
"description": "Message version"
},
"data": {
"title": "Order info",
"type": "object",
"properties": {
"order_id": {
"type": "string",
"description": "Customer defined order id"
},
"customer_order_id": {
"type": "string",
"description": "User entry order id"
},
"po_number": {
"type": "string",
"description": "Purchase Order number"
},
"customer_id": {
"type": "string",
"description": "Customer id"
},
"custom_customer_id": {
"type": "string",
"description": "Custom customer id, nullable"
},
"created_at": {
"type": "string",
"description": "Date time of order created. (From version 1.8 ISO string)"
},
"payment_method": {
"type": "string",
"description": "Order payment method"
},
"payment_id": {
"type": "string",
"description": "Order payment id"
},
"cost_center": {
"type": "object",
"description": "Order payment meta data"
},
"order_price_excl_vat": {
"type": "number",
"description": "Order price without VAT"
},
"order_price_incl_vat": {
"type": "number",
"description": "Order price with VAT"
},
"delivery_method": {
"type": "string",
"description": "Delivery Method"
},
"delivery_price_excl_vat": {
"type": "number",
"description": "Delivery price without VAT"
},
"delivery_price_incl_vat": {
"type": "number",
"description": "Delivery price with VAT"
},
"delivery_vat": {
"type": "number",
"description": "Delivery VAT rate"
},
"profit_center_id": {
"type": "string",
"description": "Profit center ID (added in v1.7), nullable"
},
"quote_id": {
"type": "string",
"desciption": "Quote ID if exist (added in v1.8), nullable"
},
"quote_version": {
"type": "int",
"desciption": "Quote version (added in v1.8), nullable. (Count of submitted quotes)"
},
"version_submitted_date": {
"type": "string",
"desciption": "Quote submtion date in ISO format (added in v1.8), nullable"
},
"quote_currency":{
"type": "string",
"desciption": "Currency (added in v1.8), nullable"
},
"currency_exchange_rate": {
"type": "number",
"desciption": "Currency exchange rate (added in v1.8), nullable"
},
"order_source": {
"type": "string",
"desciption": "Orders source. Either web or email (added in v1.8)"
},
"ticket_name": {
"type": "string",
"desciption": "Ticket name (added in v1.8)"
},
"ticket_custom_id": {
"type": "string",
"desciption": "Ticket custom ID (added in v1.8)"
},
"quote_price_excl_vat": {
"type": "nubmer",
"desciption": "Ticket price exl vat from quuote (added in v1.8), nullable"
},
"quote_price_incl_vat": {
"type": "nubmer",
"desciption": "Ticket price incl vat from quuote (added in v1.8), nullable"
},
"quote_delivery_price_excl_vat": {
"type": "nubmer",
"desciption": "Ticket delivery price exl vat from quuote (added in v1.8), nullable"
},
"quote_delivery_price_incl_vat": {
"type": "nubmer",
"desciption": "Ticket delivery price exl vat from quuote (added in v1.8), nullable"
},
"quote_created_at": {
"type": "string",
"desciption": "Quote create date (added in v1.8), nullable"
},
"creation_flow": {
"type": "string",
"desciption": "Ticket creation flow (added in v1.8), nullable"
},
"priority": {
"type": "string",
"desciption": "Ticket priority flow (added in v1.9)"
},
"region": {
"type": "string",
"desciption": "Quotation form region (added in v1.9), nullable"
},
"ticket_status": {
"type": "string",
"desciption": "Ticket status (added in v1.11), not nullable"
},
"vat_%": {
"type": "number",
"desciption": "VAT Percent applied for the ticket (added in v1.11), not nullable"
},
"customer_cc_email": {
"type": "string",
"desciption": "CC email of the customer (added in v1.11)"
},
"customer_cc_email": {
"type": "string",
"desciption": "CC email of the customer (added in v1.11)"
},
"discount_amount": {
"type": "number",
"desciption": "Total discount applied for the ticket (added in v1.11), not nullable"
},
"discount_percentage": {
"type": "number",
"desciption": "Discount percentage applied for the ticket (added in v1.11), not nullable"
},
"voucher": {
"type": "string",
"desciption": "Voucher code used for an ord2r(added in v1.11), can be en empty string"
},
"part_details": {
"type": "array",
"description": "Part details",
"items": [
{
"type": "object",
"properties": {
"part_id": {
"type": "string",
"description": "Customer defined part id of order, nullable"
},
"part_status": {
"type": "string",
"description": "Part status"
},
"height": {
"type": "number",
"description": "Object height"
},
"width": {
"type": "number",
"description": "Object width"
},
"depth": {
"type": "number",
"description": "Object depth"
},
"volume": {
"type": "number",
"description": "Object Volume"
},
"surface_area": {
"type": "number",
"description": "Object surface area"
},
"shrink_wrap_volume": {
"type": "number",
"description": "Shrink wrap volume of uploaded file, nullable"
},
"unit": {
"type": "string",
"description": "Measuring units"
},
"custom_part_name": {
"type": "string",
"description": "User entry name of the part"
},
"uploaded_file": {
"type": "string",
"description": "Filename of the original uploaded file"
},
"quoted_file": {
"type": "string",
"description": "Filename of the converted file to be printed"
},
"uploaded_file_download_link": {
"type": "string",
"description": "Download URL of the original file"
},
"quoted_file_download_link": {
"type": "string",
"description": "Download URL of the converted file to be printed"
},
"orientation": {
"type": "string",
"description": "Orientation"
},
"thumbnail": {
"type": "string",
"description": "Thumbnail"
},
"technology": {
"type": "string",
"description": "Technology"
},
"machine": {
"type": "string",
"description": "Machine"
},
"material": {
"type": "string",
"description": "Material"
},
"colour": {
"type": "string",
"description": "Color"
},
"layer_thickness": {
"type": "string",
"description": "Layer thickness"
},
"resolution": {
"type": "string",
"description": "Resolution"
},
"post_processing_services": {
"type": "array",
"description": "Post processing services",
"items": [
{
"type": "string",
"description": "Post processing service name"
}
]
},
"production_time": {
"type": "string",
"description": "Production time in human readable format"
},
"colour_code": {
"type": "string",
"description": "Color code, nullable"
},
"infill": {
"type": "string",
"description": "Infill rate, nullable"
},
"quantity": {
"type": "integer",
"description": "Quantity to be printed"
},
"request_message": {
"type": "string",
"description": "Request message, nullable"
},
"currency": {
"type": "string",
"description": "Currency"
},
"price_excl_vat": {
"type": "number",
"description": "Price without VAT"
},
"price_incl_vat": {
"type": "number",
"description": "Price with VAT"
},
"service_vat": {
"type": "number",
"description": "VAT rate"
},
"external_production_center_name": {
"type": "string",
"description": "External production center name (added in v1.7), nullable"
},
"internal_production_center_name": {
"type": "string",
"description": "Internal production center name (added in v1.7), nullable"
},
"internal_production_center_name": {
"type": "string",
"description": "Internal production center name (added in v1.7), nullable"
},
"external_production_center_margin": {
"type": "string",
"description": "External production center margin (added in v1.8), nullable"address
},
"unit_price": {
"type": "number",
"description": "Unit price (added in v1.8)"
},
"quote_unit_price": {
"type": "number",
"description": "Unit price from quote (added in v1.8), nullable"
},
"quote_price_excl_vat": {
"type": "number",
"description": "Quote price exlc vat (added in v1.8), nullable"
},
"quote_price_incl_vat": {
"type": "number",
"description": "Quote price incl vat (added in v1.8), nullable"
},
"custom_part_id": {
"type": "string",
"description": "Custom part id (added in v1.11), nullable"
},
"part_price_with_discount": {
"type": "number",
"description": "Part price with discount (added in v1.11)"
},
"quote_price_incl_vat": {
"type": "number",
"description": "Quote price incl vat (added in v1.8), nullable"
},
"quote_currency": {
"type": "string",
"description": "Quote currency (added in v1.8), nullable"
},
"production_notes": {
"type": "string",
"description": "Production notes from activity log(added in v1.9), nullable"
},
"shipping_deadline": {
"type": "string",
"description": "Part shiping deadline (added in v1.9), nullable"
},
"delivery_date": {
"type": "string",
"description": "Part delivery date (added in v1.9), nullable"
},
"waybill_number": {
"type": "array of strings",
"description": "All items in part waybil (if exist) (added in v1.9), nullable"
},
"builds": {
"type": "array of objects",
"description": "Part items in builds (added in v1.11)",
"items": [
{
"id": "string",
"description": "Build id"
},
{
"customId": "string",
"description": "Build custom id"
},
{
"name": "string",
"description": "Build name"
},
{
"quantity": "number",
"description": "Build quantity"
}
]
}
"shipping_label_number": {
"type": "array of strings",
"description": "All items in part shipping label (if exist) (added in v1.9), nullable"
},
"part_cost_breakdown": {
"type": "array",
"description": "Part cost breakdown",
"items": [
{
"type": "object",
"properties": {
"service_code": {
"type": "string",
"description": "custom_material_id or pps_custom_id"
},
"service_cost": {
"type": "string",
"description": "pps_cost or printing_cost"
},
}
}
]
},
},
"required": [
"part_id",
"part_status",
"height",
"width",
"depth",
"volume",
"surface_area",
"shrink_wrap_volume",
"unit",
"custom_part_name",
"uploaded_file",
"quoted_file",
"uploaded_file_download_link",
"quoted_file_download_link",
"orientation",
"thumbnail",
"technology",
"machine",
"material",
"colour",
"layer_thickness",
"resolution",
"post_processing_services",
"production_time",
"colour_code",
"infill",
"quantity",
"request_message",
"currency",
"price_excl_vat",
"price_incl_vat",
"service_vat",
"external_production_center_name",
"internal_production_center_name",
"part_cost_breakdown"
]
}
]
},
"manual_services": {
"type": "array",
"description": "Manual Services",
"items": [
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Manual Service item description"
},
"quantity": {
"type": "integer",
"description": "Manual Service item quantity"
},
"price_per_item": {
"type": "number",
"description": "Manual Service item price without VAT"
},
"price_per_item_incl_vat": {
"type": "number",
"description": "Manual Service item price including VAT"
},
"total_price": {
"type": "number",
"description": "Manual Service Total cost without VAT"
},
"total_price_incl_vat": {
"type": "number",
"description": "Manual Service Total cost including VAT"
},
"price_with_discount": {
"type": "number",
"description": "Manual Service Total cost including discount"
}
},
"required": [
"description",
"quantity",
"price_per_item",
"price_per_item_incl_vat",
"total_price",
"total_price_incl_vat",
"price_with_discount"
]
}
]
},
"address": {
"type": "object",
"description": "Address info",
"properties": {
"billing": {
"type": "object",
"description": "Billing address",
"properties": {
"first_name": {
"type": "string",
"description": "First Name"
},
"surname": {
"type": "string",
"description": "Last Name"
},
"company_name": {
"type": "string",
"description": "Company name"
},
"company_number": {
"type": "string",
"description": "Company number, nullable"
},
"address": {
"type": "string",
"description": "Street address"
},
"address_second_line": {
"type": "string",
"description": "Street address second line"
},
"city": {
"type": "string",
"description": "City name"
},
"post_code": {
"type": "string",
"description": "Post code, nullable"
},
"state_ISO_code": {
"type": "string",
"description": "State ISO code, nullable"
},
"state": {
"type": "string",
"description": "State name, nullable"
},
"country_ISO_code": {
"type": "string",
"description": "Country ISO code"
},
"country": {
"type": "string",
"description": "Country name"
},
"email": {
"type": "string",
"description": "Email address"
},
"vat_number": {
"type": "string",
"description": "VAT number, nullable"
},
"telephone": {
"type": "string",
"description": "Phone"
},
"fax": {
"type": "string",
"description": "Fax, nullable"
},
"industry": {
"type": "string",
"description": "Industry"
}
},
"required": [
"first_name",
"surname",
"company_name",
"company_number",
"address",
"address_second_line",
"city",
"post_code",
"state_ISO_code",
"state",
"country_ISO_code",
"country",
"email",
"vat_number",
"telephone",
"fax",
"industry"
]
},
"shipping": {
"type": "object",
"description": "Shipping address",
"properties": {
"first_name": {
"type": "string",
"description": "First Name"
},
"surname": {
"type": "string",
"description": "Last Name"
},
"company_name": {
"type": "string",
"description": "Company name"
},
"address": {
"type": "string",
"description": "Street address"
},
"address_second_line": {
"type": "string",
"description": "Street address second line"
},
"city": {
"type": "string",
"description": "City name"
},
"post_code": {
"type": "string",
"description": "Post code, nullable"
},
"state_ISO_code": {
"type": "string",
"description": "State ISO code, nullable"
},
"state": {
"type": "string",
"description": "State name, nullable"
},
"country_ISO_code": {
"type": "string",
"description": "Country ISO code"
},
"country": {
"type": "string",
"description": "Country name"
},
"email": {
"type": "string",
"description": "Email address"
},
"telephone": {
"type": "string",
"description": "Phone"
},
"fax": {
"type": "string",
"description": "Fax, nullable"
}
},
"required": [
"first_name",
"surname",
"company_name",
"address",
"address_second_line",
"city",
"post_code",
"state_ISO_code",
"state",
"country_ISO_code",
"country",
"email",
"telephone",
"fax"
]
}
},
"required": [
"billing",
"shipping"
]
}
},
{
"assignees":{
"type":"array",
"description":"Ticket assignees",
"items":[
{
"type":"object",
"properties":{
"type":{
"type":"string",
"description":"Assignee type"
},
"name":{
"type":"string",
"description":"Assignee first name"
},
"surname":{
"type":"string",
"description":"Assignee surname"
},
"email":{
"type":"string",
"description":"Assignee email"
},
"phone_number":{
"type":"string",
"description":"Assignee phone number"
},
"department":{
"type":"string",
"description":"Assignee department"
},
"company":{
"type":"string",
"description":"Assignee company"
}
},
"required":[
"type",
"name"
]
}
]
}
},
{
"customer": {
"type": "object",
"description":"Ticket customer",
"properties": {
"firstName": {
"type": "string",
"description": "Customer's first name"
},
"lastName": {
"type": "string",
"description": "Customer's last name"
},
"email": {
"type": "string",
"description": "Customer's email address"
},
"telephone": {
"type": "string",
"description": "Customer's phone number"
},
"companyName": {
"type": "string",
"description": "Customer's company name"
},
"department": {
"type": "string",
"description": "Customer's department, null if not applicable"
},
"id": {
"type": "integer",
"description": "Customer's unique identifier"
},
"customId": {
"type": "string",
"description": "Custom identifier for the customer"
},
"customerGroup": {
"type": "object",
"description": "Group information for the customer",
"properties": {
"discount": {
"type": "number",
"description": "Discount percentage for the customer group"
},
"hiddenDiscount": {
"type": "number",
"description": "Hidden discount percentage for the customer group"
},
"name": {
"type": "string",
"description": "Name of the customer group"
}
}
},
"customerRegions": {
"type": "array",
"description": "Regions associated with the customer",
"items": {
"type": "string"
}
}
},
}
}
"required": [
"order_id",
"customer_order_id",
"po_number",
"customer_id",
"custom_customer_id",
"created_at",
"payment_method",
"payment_id",
"order_price_excl_vat",
"order_price_incl_vat",
"delivery_price_excl_vat",
"delivery_price_incl_vat",
"delivery_vat",
"part_details",
"manual_services",
"address",
"profit_center_id",
"ticket_status",
"customer_cc_email",
"assignees",
"discount_amount",
"discount_percentage",
"voucher"
]
},
"signature": {
"type": "string"
}
},
"required": [
"id",
"type",
"version",
"data",
"signature"
]
}
"quote_currency": {
"type": "string",
"description": "Quote currency (added in v1.8), nullable"
},
"quote_currency": {
"type": "string",
"description": "Quote currency (added in v1.8), nullable"
},Order Push Message JSON Schema v1.15 (latest)
Written by Yordan Mitrev
Updated over 5 months ago