{ "default": {}, "description": "The root schema comprises the entire JSON document.", "examples": [ { "type": "submit", "orderid": "orderid", "shipping": { "shippingcompany": "DHL", "destination": { "postnumber": "", "packstationnumber": "", "postfilialnumber": "", "exportinvoicenumber": "12345", "customstariffnumber": "83063000", "exportvalue": "57", "email": "daniel@test.com", "first_name": "Daniel", "street": "Hauptstrasse", "street_number": "10", "phone": "", "city": "Eppelheim", "zip": "69214", "province": "", "country": "Germany", "last_name": "test", "address2": "", "company": "Die Firma", "name": "Daniel test", "country_code": "DE" }, "shipper": { "email": "daniel@test.com", "first_name": "Daniel", "street": "Mustergasse", "street_number": "25", "phone": "", "city": "Berlin", "zip": "10777", "province": "Berlin", "country": "Germany", "last_name": "test", "address2": "", "company": "sample", "latitude": "", "longitude": "", "name": "test", "country_code": "DE", "province_code": "BER" } }, "label": { "fileurl": "", "filetype": "pdf", "shippingcompany": "DHL" }, "mainitems": [ { "id": "itemi1", "type": "satin250", "size": "50x70", "fileurl": "https://www.download.printfile1", "filetype": "pdf", "designname": "Whitemap", "item_accessory": "RSD70" }, { "id": "itemid2", "type": "pinewood18mm", "size": "30x40", "fileurl": "https://www.download.printfile2", "filetype": "pdf", "designname": "Whitemap", "item_accessory": "" } ], "accessory": [ { "partnumber": "RSD70", "fileurl": "", "quantity": 1 }, { "partnumber": "INVOICE", "fileurl": "https://www.download.printfile.de/invoice123", "filetype": "pdf", "quantity": 1 } ] } ], "maxProperties": 6, "minProperties": 6, "required": [ "type", "orderid", "shipping", "label", "mainitems", "accessory" ], "type": "object", "properties": { "type": { "$id": "#/properties/type", "type": "string", "description": "Required! Possible value 'submit'", "default": "", "examples": [ "submit" ] }, "orderid": { "$id": "#/properties/orderid", "type": "string", "description": "Required! Your Ordernumber. Needs to be unique", "default": "", "examples": [ "#15428" ] }, "shipping": { "$id": "#/properties/shipping", "default": {}, "description": "Required! Contains all Information for generating a Shipment Label for you order. NOTE: If you send your own label (Key: 'label') you can leave the following values empty", "examples": [ { "shippingcompany": "DHL", "destination": { "postnumber": "", "packstationnumber": "", "postfilialnumber": "", "exportinvoicenumber": "12345", "exportvalue": "57", "email": "daniel@test.com", "first_name": "Daniel", "street": "Hauptstrasse", "street_number": "10", "phone": "", "city": "Eppelheim", "zip": "69214", "province": "", "country": "Germany", "last_name": "test", "address2": "", "company": "Die Firma", "name": "Daniel test", "country_code": "DE" }, "shipper": { "email": "daniel@test.com", "first_name": "Daniel", "street": "Mustergasse", "street_number": "25", "phone": "", "city": "Berlin", "zip": "10777", "province": "Berlin", "country": "Germany", "last_name": "test", "address2": "", "company": "sample", "latitude": "", "longitude": "", "name": "test", "country_code": "DE", "province_code": "BER" } } ], "required": [ "shippingcompany", "destination", "shipper" ], "type": "object", "properties": { "shippingcompany": { "$id": "#/properties/shipping/properties/shippingcompany", "type": "string", "description": "Required! The Shipping company you would like to use. Values: 'DHL' or 'FedEx'", "default": "", "examples": [ "DHL" ] }, "destination": { "$id": "#/properties/shipping/properties/destination", "default": {}, "description": "Required! The destination adress of the shipment", "examples": [ { "postnumber": "", "packstationnumber": "", "postfilialnumber": "", "exportinvoicenumber": "12345", "exportvalue": "57", "email": "daniel@test.com", "first_name": "Daniel", "street": "Hauptstrasse", "street_number": "10", "phone": "", "city": "Eppelheim", "zip": "69214", "province": "", "country": "Germany", "last_name": "test", "address2": "", "company": "Die Firma", "name": "Daniel test", "country_code": "DE" } ], "required": [ "postnumber", "packstationnumber", "postfilialnumber", "exportinvoicenumber", "exportvalue", "email", "first_name", "street", "street_number", "phone", "city", "zip", "province", "country", "last_name", "address2", "company", "name", "country_code" ], "type": "object", "properties": { "postnumber": { "$id": "#/properties/shipping/properties/destination/properties/postnumber", "type": "string", "description": "The DHL Account number (Postnummer) of the receipent. Only required if ship to a Packstation or DHL-Shop", "default": "", "examples": [ "" ] }, "packstationnumber": { "$id": "#/properties/shipping/properties/destination/properties/packstationnumber", "type": "string", "description": "The number of the DHL-Packstation. Only required if ship to a Packstation", "default": "", "examples": [ "" ] }, "postfilialnumber": { "$id": "#/properties/shipping/properties/destination/properties/postfilialnumber", "type": "string", "description": "The number of the DHL-Shop. Only required if ship to a DHL-Shop", "default": "", "examples": [ "" ] }, "exportinvoicenumber": { "$id": "#/properties/shipping/properties/destination/properties/exportinvoicenumber", "type": "string", "description": "The id / number of your (customer)invoice for that fulfillment. Only required for shipments outside of the EU", "default": "", "examples": [ "12345" ] }, "exportvalue": { "$id": "#/properties/shipping/properties/destination/properties/exportvalue", "type": "string", "description": "(total) Sales value in EUR of the Fulfillment. Required for shipments outside the EU", "default": "", "examples": [ "57" ] }, "email": { "$id": "#/properties/shipping/properties/destination/properties/email", "type": "string", "description": "Mail-Adress of the receipent. Used by DHL / FedEx for shipping notifications etc.", "default": "", "examples": [ "daniel@test.com" ] }, "first_name": { "$id": "#/properties/shipping/properties/destination/properties/first_name", "type": "string", "description": "First Name of the Receipent", "default": "", "examples": [ "Daniel" ] }, "street": { "$id": "#/properties/shipping/properties/destination/properties/street", "type": "string", "description": "Required! street without number!", "default": "", "examples": [ "Hauptstrasse" ] }, "street_number": { "$id": "#/properties/shipping/properties/destination/properties/street_number", "type": "string", "description": "Required! Street Number", "default": "", "examples": [ "10" ] }, "phone": { "$id": "#/properties/shipping/properties/destination/properties/phone", "type": "string", "description": "Receipent phone-number", "default": "", "examples": [ "" ] }, "city": { "$id": "#/properties/shipping/properties/destination/properties/city", "type": "string", "description": "Required! Destination City", "default": "", "examples": [ "Eppelheim" ] }, "zip": { "$id": "#/properties/shipping/properties/destination/properties/zip", "type": "string", "description": "Required! Destination ZIP", "default": "", "examples": [ "69214" ] }, "province": { "$id": "#/properties/shipping/properties/destination/properties/province", "type": "string", "description": "Destination province", "default": "", "examples": [ "BW" ] }, "country": { "$id": "#/properties/shipping/properties/destination/properties/country", "type": "string", "description": "Required! Destination country name", "default": "", "examples": [ "Germany" ] }, "last_name": { "$id": "#/properties/shipping/properties/destination/properties/last_name", "type": "string", "description": "Required! Recipients last name", "default": "", "examples": [ "test" ] }, "address2": { "$id": "#/properties/shipping/properties/destination/properties/address2", "type": "string", "description": "Additional recipient adress informations", "default": "", "examples": [ "Floor 14" ] }, "company": { "$id": "#/properties/shipping/properties/destination/properties/company", "type": "string", "description": "Company name of destination", "default": "", "examples": [ "Die Firma" ] }, "name": { "$id": "#/properties/shipping/properties/destination/properties/name", "type": "string", "description": "Additional Receipent Name (Name2 or Company2)", "default": "", "examples": [ "Distribution Center" ] }, "country_code": { "$id": "#/properties/shipping/properties/destination/properties/country_code", "type": "string", "description": "Required! Destination 2-letter country code according to ISO 3166-1 alpha-2", "default": "", "examples": [ "DE" ] } }, "additionalProperties": true }, "shipper": { "$id": "#/properties/shipping/properties/shipper", "type": "object", "description": "Information about the Sender - Will be seen as 'Shipper' on the printed label. Will be used as return adress for shipments that can not be delivered etc.", "default": {}, "examples": [ { "email": "daniel@test.com", "first_name": "Daniel", "street": "Mustergasse", "street_number": "25", "phone": "", "city": "Berlin", "zip": "10777", "province": "Berlin", "country": "Germany", "last_name": "test", "address2": "", "company": "sample", "latitude": "", "longitude": "", "name": "test", "country_code": "DE", "province_code": "BER" } ], "required": [ "email", "first_name", "street", "street_number", "phone", "city", "zip", "province", "country", "last_name", "address2", "company", "latitude", "longitude", "name", "country_code", "province_code" ], "properties": { "email": { "$id": "#/properties/shipping/properties/shipper/properties/email", "type": "string", "description": "Required! Shippers E-mail adress", "default": "", "examples": [ "daniel@test.com" ] }, "first_name": { "$id": "#/properties/shipping/properties/shipper/properties/first_name", "type": "string", "description": "Required! Shippers first name", "default": "", "examples": [ "Daniel" ] }, "street": { "$id": "#/properties/shipping/properties/shipper/properties/street", "type": "string", "description": "Required! Shippers street name without number", "default": "", "examples": [ "Mustergasse" ] }, "street_number": { "$id": "#/properties/shipping/properties/shipper/properties/street_number", "type": "string", "description": "Required! Shippers street number", "default": "", "examples": [ "25" ] }, "phone": { "$id": "#/properties/shipping/properties/shipper/properties/phone", "type": "string", "description": "Required! Shippers phone number", "default": "", "examples": [ "" ] }, "city": { "$id": "#/properties/shipping/properties/shipper/properties/city", "type": "string", "description": "Required! Shippers city", "default": "", "examples": [ "Berlin" ] }, "zip": { "$id": "#/properties/shipping/properties/shipper/properties/zip", "type": "string", "description": "Required! Shippers zip", "default": "", "examples": [ "10777" ] }, "province": { "$id": "#/properties/shipping/properties/shipper/properties/province", "type": "string", "description": "Shippers province", "default": "", "examples": [ "BW" ] }, "country": { "$id": "#/properties/shipping/properties/shipper/properties/country", "type": "string", "description": "Required! Shippers country", "default": "", "examples": [ "Germany" ] }, "last_name": { "$id": "#/properties/shipping/properties/shipper/properties/last_name", "type": "string", "description": "Required! Shippers last name", "default": "", "examples": [ "test" ] }, "address2": { "$id": "#/properties/shipping/properties/shipper/properties/address2", "type": "string", "description": "Additional address informations of the shipper", "default": "", "examples": [ "" ] }, "company": { "$id": "#/properties/shipping/properties/shipper/properties/company", "type": "string", "description": "Required! Shippers company", "default": "", "examples": [ "Company ABC" ] }, "name": { "$id": "#/properties/shipping/properties/shipper/properties/name", "type": "string", "description": "Required! Shippers surname", "default": "", "examples": [ "Mustermann" ] }, "country_code": { "$id": "#/properties/shipping/properties/shipper/properties/country_code", "type": "string", "description": "Required! Shippers 2-letter country code according to ISO 3166-1 alpha-2", "default": "", "examples": [ "DE" ] }, "province_code": { "$id": "#/properties/shipping/properties/shipper/properties/province_code", "type": "string", "description": "Shippers province code", "default": "", "examples": [ "BER" ] } }, "additionalProperties": true } }, "additionalProperties": true }, "label": { "$id": "#/properties/label", "default": {}, "description": "If you want use you own Label-File", "examples": [ { "fileurl": "", "filetype": "pdf", "shippingcompany": "DHL" } ], "required": [ "fileurl", "filetype", "shippingcompany" ], "type": "object", "properties": { "fileurl": { "$id": "#/properties/label/properties/fileurl", "type": "string", "description": "The url to download the label-file (pdf)", "default": "", "examples": [ "" ] }, "filetype": { "$id": "#/properties/label/properties/filetype", "type": "string", "description": "Filetype of the label. Only PDF is allowed", "default": "", "examples": [ "pdf" ] }, "shippingcompany": { "$id": "#/properties/label/properties/shippingcompany", "type": "string", "description": "Shipping company of the label. Possible values 'DHL', 'FedEx'", "default": "", "examples": [ "DHL" ] } } }, "mainitems": { "$id": "#/properties/mainitems", "type": "array", "description": "This section contains all information of the items to print (poster etc)", "default": [], "examples": [ [ { "id": "itemi1", "type": "satin250", "size": "50x70", "fileurl": "https://www.download.printfile1", "filetype": "pdf", "designname": "Whitemap", "item_accessory": "RSD70" }, { "id": "itemid2", "type": "pinewood18mm", "size": "30x40", "fileurl": "https://www.download.printfile2", "filetype": "pdf", "designname": "Whitemap", "item_accessory": "" } ] ], "items": { "$id": "#/properties/mainitems/items", "anyOf": [ { "$id": "#/properties/mainitems/items/anyOf/0", "type": "object", "description": "Every 'item' is a print (Poster). Max of 6 Prints per order", "default": {}, "examples": [ { "id": "itemi1", "type": "satin250", "size": "50x70", "fileurl": "https://www.download.printfile1", "filetype": "pdf", "designname": "Whitemap", "item_accessory": "RSD70" } ], "required": [ "id", "type", "size", "fileurl", "filetype", "designname", "item_accessory" ], "properties": { "id": { "$id": "#/properties/mainitems/items/anyOf/0/properties/id", "default": "", "description": "Id of the item, alphanumerical string, must be unique within an order", "examples": [ "itemi1" ], "minLength": 1, "type": "string" }, "type": { "$id": "#/properties/mainitems/items/anyOf/0/properties/type", "type": "string", "description": "Required! Type of substrate / print. Possible combination of 'substrate' an 'size' can be requested over the API with the operation 'getarticles'", "default": "", "examples": [ "satin250" ] }, "size": { "$id": "#/properties/mainitems/items/anyOf/0/properties/size", "type": "string", "description": "Required! Size of print. Possible combination of 'substrate' an 'size' can be requested over the API with the operation 'getarticles'", "default": "", "examples": [ "50x70" ] }, "fileurl": { "$id": "#/properties/mainitems/items/anyOf/0/properties/fileurl", "type": "string", "description": "Required! url of the print file", "default": "", "examples": [ "https://www.download.printfile1" ] }, "filetype": { "$id": "#/properties/mainitems/items/anyOf/0/properties/filetype", "type": "string", "description": "Required! file-type / extension of the print file. Allowed vlaues: 'pdf', 'png', 'jpeg', 'tiff'", "default": "", "examples": [ "pdf" ] }, "designname": { "$id": "#/properties/mainitems/items/anyOf/0/properties/designname", "type": "string", "description": "Your name of the Print(design). Used for customer specific print settings", "default": "", "examples": [ "Whitemap" ] }, "item_accessory": { "$id": "#/properties/mainitems/items/anyOf/0/properties/item_accessory", "type": "string", "description": "Optional: only needed if items has 'accessory'. Contains the article-number of the accessory. Used to match frame-color to print on orders with multiple prints", "default": "", "examples": [ "RSD70" ] } }, "additionalProperties": true } ] } }, "accessory": { "$id": "#/properties/accessory", "type": "array", "description": "Additional Items of the order. Like Frames, Poster Hangers, Delivery-Note, Invoice etc. Possible values can be requested over the API with the operation 'getarticles'", "default": [], "examples": [ [ { "partnumber": "RSD70", "fileurl": "", "quantity": 1 }, { "partnumber": "INVOICE", "fileurl": "https://www.download.printfile.de/invoice123", "filetype": "pdf", "quantity": 1 } ] ], "items": { "$id": "#/properties/accessory/items", "anyOf": [ { "$id": "#/properties/accessory/items/anyOf/0", "type": "object", "description": "One Item for every accessory ", "default": {}, "examples": [ { "partnumber": "RSD70", "fileurl": "", "quantity": 1 } ], "required": [ "partnumber", "fileurl", "quantity" ], "properties": { "partnumber": { "$id": "#/properties/accessory/items/anyOf/0/properties/partnumber", "type": "string", "description": "Article-Number. Possible values can be requested over the API with the operation 'getarticles'", "default": "", "examples": [ "RSD70" ] }, "fileurl": { "$id": "#/properties/accessory/items/anyOf/0/properties/fileurl", "type": "string", "description": "Url of the print file. Only need for printable accessory like Invoices etc.", "default": "", "examples": [ "" ] }, "quantity": { "$id": "#/properties/accessory/items/anyOf/0/properties/quantity", "type": "integer", "description": "quantity", "default": 0, "examples": [ 1 ] } }, "additionalProperties": true }, { "$id": "#/properties/accessory/items/anyOf/1", "type": "object", "description": "An explanation about the purpose of this instance.", "default": {}, "examples": [ { "partnumber": "INVOICE", "fileurl": "https://www.download.printfile.de/invoice123", "filetype": "pdf", "quantity": 1 } ], "required": [ "partnumber", "fileurl", "filetype", "quantity" ], "properties": { "partnumber": { "$id": "#/properties/accessory/items/anyOf/1/properties/partnumber", "type": "string", "description": "Article-Number. Possible values can be requested over the API with the operation 'getarticles'", "default": "", "examples": [ "INVOICE" ] }, "fileurl": { "$id": "#/properties/accessory/items/anyOf/1/properties/fileurl", "type": "string", "description": "Url of the print file. Only need for printable accessory like Invoices etc.", "default": "", "examples": [ "https://www.download.printfile.de/invoice123" ] }, "filetype": { "$id": "#/properties/accessory/items/anyOf/1/properties/filetype", "type": "string", "description": "Filetype. Only PDF is allowed", "default": "", "examples": [ "pdf" ] }, "quantity": { "$id": "#/properties/accessory/items/anyOf/1/properties/quantity", "type": "integer", "description": "quantity", "default": 0, "examples": [ 1 ] } }, "additionalProperties": true } ] } } } }