This document outlines the process and format through which Mixam sends printed item fulfilment instructions in MxJdf4. Suppliers that integrate with Mixam also have the option to use Webhooks (instead of the Mixam web portal) to accept orders, mark orders as labeled, and notify Mixam of dispatch delays.
The Mixam Job Description Format (MxJdf) describes the structure of a print job in an unambiguous way.
Although the Mixam Platform is capable of specifying a job in many formats (cXML, OneFlow, and several vendor-specific formats), MxJdf is the most complete, the most useful, and the recommended way to establish an automated connection with us.
The MxJdf format is made of attributes and values and can be provided as an XML and/or JSON document. We also provide a Java implementation of the MXJDF format, but it can easily be implemented with other programing languages such as PHP or JavaScript.
MxJdf documents can be attached to an email message or posted to the printer's preferred end-point using HTTPS or SFTP.
The top level of the MxJdf document contains the following elements:
{
"version": 4.01.05,
"desc": "mixam.job.description",
"dateCreated": 1579177108174,
"author" : "Sherlock Holmes",
"referencedJobNumber": 303171489,
"shopName" : "mixam",
"price" : 105.31,
"packagingCost" : 2.50,
"currencyCode": "gbp",
"job": {...},
"export": {...},
"attributes": [...]
}| Property | Description | Values |
|---|---|---|
| version | Current version of the protocol. (String) | Currently ‘4.01.03’ |
| desc | Document description. (String) | Always "mixam.job.description" |
| dateCreated | Epoch date of creation. (Long number) | A Unix Timestamp of the date the document was created |
| author | The name of the person who created the document. (String) | |
| referencedJobNumber | The id of the associated order in the Mixam system. (String) |
|
| shopName | The name of the shop where the order originated from (String) | |
| price | The pre-agreed cost price of the job (Double precision number) | |
| packagingCost | Cost attributed towards packaging (Double precision number) | |
| currencyCode | The currency in which the price is specified. (String) | “GBP”, “USD”, “CAD”, “AUD” |
| job | A map of properties describing the job. | See bellow |
| export | A map of properties describing the export value of the goods. (Map). Applicable only when goods are shipped overseas. | See bellow. |
"job": {
"article": {...},
"details": {...},
"shipment": {...}
}| Property | Description | Values |
|---|---|---|
| article | The article describes the print requirements (map) | See bellow |
| details | Contains some meta data regarding the number of copies, tax and alternative id. (map) | See bellow |
| associatedProof | (Optional) Information about a previous proof job, if applicable | See below |
| shipment | Contains addresses and delivery details | See bellow |
"article": {
"components": [...],
"type": 0,
"product": 1,
"subProduct": 1,
"rightToLeft": false,
"productionDays": 3,
"bundling": {...},
"additionalFiles": [...]
}| Property | Description | Values |
|---|---|---|
| components | A list of components (such as text, cover, dust jacket etc.) (List) | See bellow |
| type | Taxation type (VAT, GST etc.) (ArticleTaxType) | EXEMPT(0), VAT(1), GST(2), USA_TAX(3); |
| product | The product id (ProductGroupType) | INVALID(0), PRODUCT_BROCHURES(1), PRODUCT_FLYERS(2), PRODUCT_FOLDED(3), PRODUCT_POSTERS(4), PRODUCT_LETTERHEADS(5), PRODUCT_PHOTO_BOOK(6), PRODUCT_BOOK(7), PRODUCT_BUSINESS_CARD(8), PRODUCT_POSTCARD(9), PRODUCT_GREETING_CARD(10) PRODUCT_NOTE_BOOK(11), PRODUCT_COMPLIMENT_SLIPS(12), PRODUCT_ENVELOPES(13), PRODUCT_FOLDERS(14), PRODUCT_LAYFLAT(15), PRODUCT_WALL_CALENDARS(16), PRODUCT_DESK_CALENDARS(17) PRODUCT_VR_WALL_CALENDARS(18) PRODUCT_VR_DESK_CALENDARS(19), PRODUCT_TRADITIONAL_BOOK(20), PRODUCT_CANVAS(21), DUST_JACKETS(36) ; |
| subProduct | Fine classification of the product. (optional) (SubProductType) | PRODUCT_HARD_COVER_BOOKS(1) PRODUCT_PAPERBACK_BOOKS(2) PRODUCT_PERFECT_BOOKLETS(3) PRODUCT_WIRO_BOOKLETS(4) PRODUCT_LOOP_BOOKLETS(5) PRODUCT_STAPLED_BOOKLETS(6) PRODUCT_MAGAZINES(7) PRODUCT_CATALOGS(8) PRODUCT_BOOKLETS(9) PRODUCT_ZINES(10) PRODUCT_COMIC_BOOKS(11) PRODUCT_ART_PRINTS(12) PRODUCT_MANGA(13) PRODUCT_WEDDING_BOOK(14) PRODUCT_YEARBOOK(15) PRODUCT_COOKBOOK(16) PRODUCT_COLOURINGBOOK(17) PRODUCT_ARTBOOK(18) PRODUCT_GRAPHIC_NOVEL(19) PRODUCT_LOOKBOOK(20) PRODUCT_DIARIES(21) PRODUCT_JOURNALS(22) PRODUCT_MENUS(23) PRODUCT_CLASSIC_BOOKS(24) PRODUCT_CLASSIC_PAPERBACK_BOOKS(25) PRODUCT_FAMILY_HISTORY_BOOKS(26) PRODUCT_ACTIVITY_BOOKS(27) PRODUCT_MEMOIRS(28) PRODUCT_CHILDRENS_BOOKS(29) PRODUCT_WORKBOOKS(30) PRODUCT_PHOTO_BOOKS(31) PRODUCT_PHOTOGRAPHY_BOOKS(32) PRODUCT_COFFEE_TABLE_BOOKS(33) PRODUCT_MANUALS(34) PRODUCT_BABY_BOOKS(35) PRODUCT_BIOGRAPHY(36) PRODUCT_NOVELS(37) PRODUCT_POETRY_BOOKS(38) PRODUCT_SPIRAL_BOOKLETS(39) PRODUCT_GICLEE_ART_PRINTS_SMALL_FORMAT(40) PRODUCT_GICLEE_ART_PRINTS_LARGE_FORMAT(41) PRODUCT_STAPLED_CALENDAR(42) PRODUCT_NOTEBOOKS(43) PRODUCT_BOOKMARKS(44) PRODUCT_WIRO_CALENDAR(45) PRODUCTS_THESES(46) PRODUCT_DISSERTATIONS(47) PRODUCT_TEXTBOOKS(48) PRODUCT_HANDBOOKS(49) PRODUCT_POSTER_CALENDARS(50) PRODUCT_SKETCH_COVER_COMIC_BOOKS(51) PRODUCT_KITCHEN_CALENDARS(52) PRODUCT_MIXAM_TEST(999999); |
| rightToLeft | Field to indicates if the item is right to left | true or false |
| productionDays | Number of calculated production days for the item | 1, 2, 3,…100 |
| bundling | Bundling element describing any bundling requirements for the order | See bellow |
| additionalFiles | A list of additional artwork files that aren't associated with a specific component. (List) | See bellow |
{
"pages": 4,
"chromaticity": {...},
"format": {...},
"material": {...},
"processing": {...},
"files": [...],
"type": 2
}| Property | Description | Values |
|---|---|---|
| pages | Number of pages in the component (Integer number) | 4, 8, 32, to name a few |
| chromaticity | Chromaticity element which specify the colour space on the front and back | See below |
| format | Format element which specify the component measurements | See below |
| material | Material element which specify the component paper stock. | See below |
| processing | Processing element which specify additional processing such as binding. | See below |
| files | A list of artwork files associated with the component. (List) | See bellow |
| type | ComponentType | INVALID(0), CONTENT(1), COVER(2), JACKET(3), BOOKMARK(4), ENVELOPE (5) |
{
"front": 3,
"back": 3
}| Property | Description | Values |
|---|---|---|
| front | Colour space on front / outside. (ColorType) | INVALID (0), HKS (1), BLACK (2), PROCESS (3); |
| back | Colour space on back / inside. (ColorType) | INVALID (0), HKS (1), BLACK (2), PROCESS (3); |
Specifies the dimensions of the component in localised units (i.e. mm or inches). These are
ordinarily the dimensions at which the article was sold; so in the case of an A5 hardcover book,
both the body and the cover components would have 210 for the longEdge and 148 for the
shortEdge. Also in the case of folded products, if the article was sold to the customer using flat
sizes (US & Canada) these dimensions will match the flat size of the article; in other locales these
dimensions will match the folded size.
If the article contains a dust jacket component, by contrast, these dimensions on that component will match the trim box of the actual artwork for the just jacket.
"format": {
"longEdge": 210,
"orientation": 1,
"shortEdge": 99,
"units": 0
}| Property | Description | Values |
|---|---|---|
| longEdge | Component long axis. (Double precision number) in shop’s units | |
| shortEdge | Component short axis. (Double precision number) in shop’s units | |
| orientation | (OrientationType) | PORTRAIT(0), LANDSCAPE(1); |
| units | The units in which the edges are specified. mm on metric system, inch on imperial. | MM (0), INCH(1), |
"material": {
"glossiness": 1,
"weight": 170,
"units": 1,
"type": 4,
"refinings": [{...}, {...}]
}| Property | Description | Values |
|---|---|---|
| glossiness | Paper glossiness (MaterialGlossinessType) | NONE(0), MATT(1), GLOSS(2), |
| weight | The weight on one unit (Integer number) | |
| units | Units of weight (PaperWeightUnit) | INVALID(0), GSM(1), LIBRA_COVER(2), LIBRA_TEXT(3), LIBRA_CARD(4), |
| type | (MaterialType) (SILK is known as SATIN in the US) | INVALID(0) SILK(1) GLOSS(2) UNCOATED(3) AFFICHE_PAPER(4) OUTDOOR_PAPER(5) ILLUSTRATION_PRINTING_PAPER(6) PHOTOGRAPHIC_PRINTING_PAPER(7) POSTCARD_BOARD(8) RECYCLED_NATURAL_PAPER(9) RECYCLED_SILK_PAPER(10) MATT(11) WEATHERPROOF_VINYL(12) RECYCLED_UNCOATED_PAPER(13) POLYESTER_CANVAS(14) PREMIUM_WHITE(15) CREME(16) E_PHOTO_PAPER(17) E_PHOTO_SILK_LUSTRE(18) ARCHIVAL_MATT(19) ARCHIVAL_UNCOATED(20) ARCHIVAL_TEXTURED_MATT(21) PHOTO_LUSTRE(22) |
| refinings | List of refining options such as lamination, spot UV, etc. (MaterialRefining) | See below |
| color | The colour of the material | WHITE (0), YELLOW(1), GREEN(2), RED(3) |
"refining": {
"effect": 2,
"side": 1,
"type": 3
}| Property | Description | Values |
|---|---|---|
| effect | (RefiningEffect) | NONE (0), MATT_FINISH(1), GLOSS_FINISH (2), SILK_FINISH (3), SOFT_TOUCH (4), GOLD (5), SILVER (6), COPPER (7), RED (8), BLUE (9), GREEN (10) MATT_ANTI_SCUFF(11) |
| side | (RefiningSideType) | NONE(0), FRONT(1), BACK(2), FRONT_AND_BACK(3), OUTSIDE(4), INSIDE (5) OUTSIDE_AND_INSIDE(6) |
| type | (RefiningType) | NONE (0) ULTRA_VIOLET_COATING(1) LAMINATION (2), PROTECTIVE_FOIL (3) METAL_FOIL (4) SOFT_PVC_FILM_LAMINATION (5) ULTRA_VIOLET_SPOT_COATING (6) DISPERSION_COATING (7) BIND_EMBOSSING (8) RELIEF_SPOT_COATING (9) ULTRA_VIOLET_3D_SPOT_COATING(10) |
"processing": {
"binding": {...},
"creasing": 0,
"folding": 0,
"headTailBand": 1,
"ribbon": 0,
"window": 0,
"feature": 0,
"frameDepth": 0,
"substrateDesign": 0,
"preDrilledHoles": 0
}| Property | Description | Values |
|---|---|---|
| binding | Binding element (map) | See below |
| creasing | (CreasingType) | NONE(0), >CREASING_NECESSARY(1) |
| folding | (FoldingType) | FLAT (0), HALF (1), LETTER (2), Z (3), GATE_OPEN (4), GATE_CLOSED (5), CROSS (6), DOUBLE_PARALLEL (7) |
| headTailBand | Ratchford (BandType) | NONE(0), BLACK_AND_WHITE_69WS(1), WHITE_T117(2), GREEN_AND_BIEGE_72WS(3), DARK_BLUE_AND_WHITE_64WS(4), RED_T105(5), MAROON_AND_WHITE_66WS(6), BROWN_AND_BIEGE_58WS(7), RED_AND_WHITE_56WS(8), MEDIUM_GREY_T109(9), YELLOW_T122(10), BLACK_T108(11), LIGHT_BLUE_AND_WHITE_634WS(12), YELLOW_AND_DARK_BLUE_59WS(13), RED_AND_GREY_55WS(14), RED_AND_YELLOW_65WS(15), NAVY_T118(16), GREEN_AND_BLACK_52WS(17), PURPLE_AND_WHITE_54WS(18), BLACK_AND_DARK_GREEN_71WS(19), GREEN_AND_RED_61WS(20), RED_AND_BLACK_53WS(21), YELLOW_AND_BROWN_57WS(22), YELLOW_AND_BLACK_67WS(23), GREEN_AND_WHITE_68WS(24), GREEN_AND_YELLOW_62WS(25), NAVY_AND_GOLD(26), |
| ribbon | Ratchford (RibbonType) | NONE(0), WHITE(1), IVORY(2), GOLD(3), ORANGE(4), BRIGHT_RED(5), MAROON(6), BABY_PINK(7), PURPLE(8), LIGHT_BLUE(9), BABY_BLUE(10), NAVY_BLUE(11), FREASH_GREEN(12), DARK_GREEN(13), GREY(14), BLACK(15), |
| window | Envelope window (WindowType) | NONE(0), LEFT(1), RIGHT(2) |
| feature | (FeatureType) | INVALID(0), SUPPLY_FOLDED(1), SUPPLY_NOT_FOLDED(2), PERFORATED_ON_TOP(3), PERFORATED_LEFT(4), PEEL_AND_SEAL(5) |
| frameDepth | Depth of frame (framed products only) | MM_18(1), MM_38(2) |
| substrateDesign | Supplier supplied pre-printed design | NONE(0), LINED(1 ) |
| preDrilledHoles | Hole Drilling | NONE(0) ONE_HOLE_OPPOSITE_BINDING_CENTER(1) ONE_HOLE_TOP_CENTER(2) |
{
"type": 2,
"color": 0,
"loops": 0,
"endPaperColor": 0,
"spineWidth": 7.5,
"sewn": false,
"edge": 0
}| Property | Description | Values |
|---|---|---|
| type | (BindingType) | NONE(0), STAPLED (1), PUR (2), WIRO (3), LOOP (4), CASE (5), CASE_BOUND_WITH_SEWING (6), CALENDAR (7), COIL (8) |
| color | Wiro or coil spiral colour (BindingColorType) | NONE (0), BLACK (1), SILVER (2), WHITE (3), CLEAR (4), RED (5), BLUE (6), REFLEX_BLUE (7), YELLOW (8), COLLEGE_ORANGE (9), RED_WINE (10), BURGUNDY (11), PINK (12), PASTEL_PINK (13), FUSCHIA (14), NAVY_BLUE (15), PASTEL_BLUE (16), ROYAL_BLUE (17), TEAL (18), MEDIUM_GREEN (19), PASTEL_GREEN (20), APPLE_GREEN (21), PEARL_GREY (22), DARK_BROWN (23), PASTEL_BEIGE (24), CHOCOLATE_BROWN (25), NEON_GREEN (26), ORANGE (27), NEON_PINK (28), NEON_ORANGE (29), WARM_RED (30), PURPLE (31), VIOLET (32), FOREST_GREEN (33), DARK_GREEN (34), GOLD (35) |
| loops | How many loop holes. (LoopsType) | NONE (0), TWO (1), FOUR (2), |
| endPaperColor | (EndPaperColorType) | NONE(0), WHITE(1), BLACK(2); COLORPLAN_ADRIATIC(10) COLORPLAN_AMETHYST(11) COLORPLAN_AZURE_BLUE(12) COLORPLAN_BAGHDAD_BROWN(13) COLORPLAN_BITTER_CHOCOLATE(14) COLORPLAN_BRIGHT_RED(15) COLORPLAN_BRIGHT_WHITE(16) COLORPLAN_CANDY_PINK(17) COLORPLAN_CHINA_WHITE(18) COLORPLAN_CITRINE(19) COLORPLAN_CLARET(20) COLORPLAN_COBALT(21) COLORPLAN_COOL_BLUE(22) COLORPLAN_COOL_GREY(23) COLORPLAN_DARK_GREY(24) COLORPLAN_EBONY(25) COLORPLAN_EMERALD(26) COLORPLAN_FACTORY_YELLOW(27) COLORPLAN_FOREST(28) COLORPLAN_FUSCHIA_PINK(29) COLORPLAN_HARVEST(30) COLORPLAN_HOT_PINK(31) COLORPLAN_ICE_WHITE(32) COLORPLAN_IMPERIAL_BLUE(33) COLORPLAN_LAVENDAR(34) COLORPLAN_LOCKWOOD_GREEN(35) COLORPLAN_MANDARIN(36) COLORPLAN_MARRS_GREEN(37) COLORPLAN_MID_GREEN(38) COLORPLAN_MIST(39) COLORPLAN_NATURAL(40) COLORPLAN_NEW_BLUE(41) COLORPLAN_NUBUCK_BROWN(42) COLORPLAN_PALE_GREY(43) COLORPLAN_PARK_GREEN(44) COLORPLAN_PISTACHIO(45) COLORPLAN_POWDER_GREEN(46) COLORPLAN_PRISTINE_WHITE(47) COLORPLAN_PURPLE(48) COLORPLAN_RACING_GREEN(49) COLORPLAN_REAL_GREY(50) COLORPLAN_ROYAL_BLUE(51) COLORPLAN_SAPPHIRE(52) COLORPLAN_SCARLET(53) COLORPLAN_SMOKE(54) COLORPLAN_SORBET_YELLOW(55) COLORPLAN_STONE(56) COLORPLAN_TABRIZ_BLUE(57) COLORPLAN_TURQUOISE(58) COLORPLAN_VELLUM_WHITE(59) COLORPLAN_VERMILLION(60) COLORPLAN_WHITE_FROST(61) |
| spineWidth | (Double precision number) | In shops units (mm in the UK, inch in the US) |
| sewn | Indicates if the sections are sewn | FALSE, TRUE |
| edge | Indicates which edge the item is bound upon | LEFT_RIGHT(0), TOP_BOTTOM(1) |
"details": {
"additionalProjectName": "370260/1",
"completionType": 3,
"assumedPrintType": 1,
"totalCirculation": 400,
"jobType": 0,
"orderType": 0,
"remark": "£15 bundle in 500's cost added to supplier cost total as discussed",
"machineName": "B3D-Z"
}| Property | Description | Values |
|---|---|---|
| additionalProjectName | Additional Order number. Reference number. (String) | |
| completionType | Urgency of the job. Default value is 4 (Standard) | INVALID(0), SAME_DAY(1), EXPRESS(2), OVERNIGHT(3), STANDARD(4), SAVER(5); |
| totalCirculation | The total number of copies (Integer) | |
| assumedPrintType | The expected print technology | NONE(0), LITHO(1), DIGITAL(2), INKJET(3) |
| jobType | Classification of print job | PRIMARY_PRINT(0), RIPPED_PROOF(1), HARD_COPY_PROOF(2) |
| orderType | Classification of order, if applicable | STANDARD(0), PRINT_ON_DEMAND(1), FOURTHWALL(2) |
| remark | Remarks for the supplier added by Mixam at fulfilment-time, if any (String) | |
| machineName | The name of the recommended machine for this job identified by our pricing engine (String) |
"associatedProof": {
"proofJobNumber": "532809",
"proofJobType": 1,
"proofDate": 1579177108174
}| Property | Description | Values |
|---|---|---|
| proofJobNumber | The id of the associated proof order in the Mixam system. (String) |
|
| proofJobType | Print job classification of the associated proof order | RIPPED_PROOF(1), HARD_COPY_PROOF(2) |
| proofDate | The date the proof job was fulfilled | A Unix Timestamp of the date the document was fulfilled |
NOTE: jobs that did not have a proof previously will not include the
associatedProofelement.
"shipment": {
"deliveryAddresses": [...],
"senderForLabel": {...},
"weight": 1.2
"units": 1,
"splitDeliveryAdditionalCharge": 0
}| Property | Description | Values |
|---|---|---|
| deliveryAddresses | A list of RecipientAddress elements. (List) | See bellow |
| senderForLabel | The sender address. (Address) | See bellow |
| Weight | The expected weight of the goods. (Double precision number) | |
| units | The units in which the weight is specified. KILOGRAM on metric system, LIBRA on imperial. | KILOGRAM(0), LIBRA(1), |
| splitDeliveryAdditionalCharge | Additional charge for split shipments |
NOTE: ripped (digital) proof jobs will not contain a
shipmentelement.
"bundling": {
"bundlingType": {...},
"bundleSize": 10
}| Property | Description | Values |
|---|---|---|
| bundlingType | The type of bundling | SHRINK_WRAP(1) |
| bundleSize | Number of items in each bundle |
{
"deliveryId": "abc123456",
"address": {...},
"circulation: 100,
"delivery": {...},
"dispatchDate": 1579693407751,
"deliveryDate": 1579695818930,
"instructions": "Please leave parcels behind the bins"
}| Property | Description | Values |
|---|---|---|
| deliveryId | Unique identifier of the delivery (String). | Useful in cases where the supplier needs to report back a completion of a specific delivery |
| address | Address of recipient (Address) | See bellow |
| circulation | How many copies to this specific address. (Integer number) | |
| delivery | Delivery details. (Delivery) | See bellow |
| dispatchDate | Epoch date of dispatch (when the boxes are due to be collected by the carrier.) (Long number) | A Unix Timestamp |
| deliveryDate | Epoch date of delivery (when the boxes are due to arrive at the customer address.) (Long number) | A Unix Timestamp |
| instructions | Delivery instructions (String) |
"address": {
"salutation": "Mr.",
"firstName": "Sherlock",
"surName": "Holmes",
"street1": "221B Baker Street",
"county": "Marylebone",
"postalCode": "NW1 6XE",
"city": "London",
"country": "GB",
"telephoneNumber": "07585055748",
"email": "machinemagazine@mail.com"
}See type ‘Address’
"senderForLabel": {
"salutation": "Mr.",
"companyName": "Mixam Print",
"firstName": "Arthur",
"surName": "Conan Doyle",
"street1": "6 Hercules Way",
"street2": "Building 1"
"county": "Hertfordshire",
"postalCode": "WD25 7GS",
"city": "Watford",
"country": "GB",
"telephoneNumber": "01923 594 040",
"email": "info@mixam.co.uk"
}See type ‘Address’
{
"salutation": "Mr.",
"companyName": "Mixam Print",
"firstName": "Arthur",
"surName": "Conan Doyle",
"street1": "6 Hercules Way",
"street2": "Building 1"
"county": "Hertfordshire",
"postalCode": "WD25 7GS",
"city": "Watford",
"country": "GB",
"telephoneNumber": "01923 594 040",
"locationType": 0,
"email": "info@mixam.co.uk"
}| Property | Description | Values |
|---|---|---|
| salutation | (SalutationType) | MX("Mx."), MS("Ms."), MR("Mr."), DR("Dr."), MRS("Mrs"), PROF("Prof"), PROF("Prof"), NOT_APPLICABLE("") |
| companyName | (String) | |
| firstName | (String) | |
| surName | (String) | |
| street1 | (String) | |
| street2 | Optional (String) | |
| street3 | Optional (String) | |
| county | Usually county name. State in the US. (String) | |
| postalCode | Postcode in the UK, zip in US. (String) | |
| city | (String) | |
| country | (String) | “GB”, “US”, “CA” or “AU” |
| telephoneNumber | (String) | |
| (String) | ||
| locationType | (AddressLocationType) | RESIDENTIAL(0), BUSINESS_DOCK(1), BUSINESS_NO_DOCK(2), LIMITED_ACCESS(3), TRADE_SHOW(4), CONSTRUCTION(5), FARM(6), |
"delivery": {
"type": "parcel",
"carrier": "UPS",
"serviceType": "Next day air",
"serviceDescription": "By Friday, 17:00",
"canonicalUri": "UPS_NEXTDAYAIR_2_XCR_Z",
"cost": 6.50
"url": "https://mixam.co.uk/spedition/1234567890abcdefghijklmn",
"packagingType": 0
}| Property | Description | Values |
|---|---|---|
| type | (DeliveryType) | PARCEL(0), PALLET(1), ENVELOPE(2); |
| carrier | The name of the carrier (String) | DPD, 2MV, Mini Clipper etc. |
| serviceType | Usually Next day (in the UK) (String) | |
| serviceDescription | (String) | |
| canonicalUri | A unique identifier of the service (String) | |
| cost | Cost of delivery (Double precision number) | |
| url | Points to a page where collection can be summoned and shipment labels printed. (String) | |
| packagingType | Type of packaging that should be used with this delivery | STANDARD(0), PLAIN(1) |
{
"type": 0,
"name": "job123456.pdf",
"url": "https://s3-eu-...1234567890abcdefghijklmn/job123456.pdf",
"checksum": "90be4101398f7f9bc95abe8b1d0f7447",
"sizeInBytes": 1865517,
"trimBox": {...}
}| Property | Description | Values |
|---|---|---|
| type | Which component is associated with this file. (FileType) | ALL(0), BODY(1), COVER(2), DUST_JACKET(3), HEAD_TO_HEAD(4) |
| name | Name of file (String) | |
| url | Where to download this file (String) | |
| checksum | MD5 checksum of this file. (String) | |
| sizeInBytes | Size of file (Long number) | |
| flags | Helpful metadata that describes the content of the file. (FileFlags) | See below |
| trimBox | Dimensions of the artwork file's trim box. (Dimensions) | See bellow |
{
"headToHead": true,
"coverSingles": true,
"spotUv": true,
"foilGold": true,
"foilSilver": true,
"foilCopper": true,
"foilRed": true,
"foilBlue": true,
"foilGreen": true
}| Property | Description | Values |
|---|---|---|
| headToHead | (Optional) whether front and back sides are imposed head-to-head | true or absent |
| coverSingles | (Optional) whether frond an back cover are imposed as separate pages | true or absent |
| spotUv | (Optional) the file contains a separation (guide) layer for Spot UV | true or absent |
| spotUv3d | (Optional) the file contains a separation (guide) layer for Spot UV 3D | true or absent |
| foilGold | (Optional) the file contains a separation (guide) layer for gold foil | true or absent |
| foilSilver | (Optional) the file contains a separation (guide) layer for silver foil | true or absent |
| foilCopper | (Optional) the file contains a separation (guide) layer for copper foil | true or absent |
| foilRed | (Optional) the file contains a separation (guide) layer for red foil | true or absent |
| foilBlue | (Optional) the file contains a separation (guide) layer for blue foil | true or absent |
| foilGreen | (Optional) the file contains a separation (guide) layer for green foil | true or absent |
"format": {
"longEdge": 210,
"shortEdge": 99,
"units": 0
}| Property | Description | Values |
|---|---|---|
| longEdge | Component long axis. (Double precision number) in shop’s units | |
| shortEdge | Component short axis. (Double precision number) in shop’s units | |
| units | The units in which the edges are specified. mm on metric system, inch on imperial. | MM (0), INCH(1), |
Optional, applicable only when goods are shipped overseas.
"export": {
"customsValueSum": 100,
"customsValueCurrency": "USD"
}| Property | Description | Values |
|---|---|---|
| customsValueSum | Value of the goods for custom evaluation. (Integer number) | |
| customsValueCurrency | Currency code of the above value. | GBP, USD, CAD, AUD |
NOTE: ripped (digital) proof documents will not contain an
exportelement.
Flexible, open-ended model for including additional metadata with an MxJdf4 document.
{
"name": "refernceNumber",
"value": "1234567"
}| Property | Description | Values |
|---|---|---|
| name | The name of the attribute | |
| value | The value of the attribute |
{
"version": "4.01.05",
"desc": "mixam.job.description",
"referencedJobNumber": "484134",
"author": "Sherlock Holmes",
"dateCreated": 1603279100614,
"job": {
"article": {
"components": [
{
"pages": 4,
"chromaticity": {
"front": 3,
"back": 0
},
"format": {
"longEdge": 297.0,
"orientation": 0,
"shortEdge": 210.0,
"units": 0
},
"material": {
"weight": 170,
"units": 1,
"refinings": [
{
"effect": 2,
"side": 4,
"type": 2
}
],
"type": 1,
"color": 0
},
"processing": {},
"type": 2,
"files": [
{
"type": 2,
"name": "job123456-cover.pdf",
"url": "https://s3.wasabisys.com/files.mixam.com/1234567890abcdefghijklmnopqrstuvwxyz1234/job123456-cover.pdf",
"checksum": "4e8dcebe35e8b00dbd6b7b72ecbcba38",
"sizeInBytes": 13273803
}
]
},
{
"pages": 28,
"chromaticity": {
"front": 2,
"back": 3
},
"format": {
"longEdge": 297.0,
"orientation": 0,
"shortEdge": 210.0,
"units": 0
},
"material": {
"weight": 200,
"units": 1,
"refinings": [],
"type": 1,
"color": 0
},
"processing": {
"binding": {
"type": 5,
"endPaperColor": 2,
"spineWidth": 28.0
}
},
"type": 1,
"files": [
{
"type": 1,
"name": "job123456-body.pdf",
"url": "https://s3.wasabisys.com/files.mixam.com/1234567890abcdefghijklmnopqrstuvwxyz1234/job123456-body.pdf",
"checksum": "05551af33a81f6f13802ca1858919414",
"sizeInBytes": 256689704
}
]
}
],
"type": 0,
"product": 7,
"subProduct": 0,
"rightToLeft": false,
"productionDays": 3
},
"details": {
"additionalProjectName": "5f7c9449a478e23e57444661",
"completionType": 4,
"totalCirculation": 1,
"assumedPrintType": 2,
"orderId": "1234567890abcdefghijklmn"
},
"shipment": {
"deliveryAddresses": [
{
"deliveryId": "12345678-abcd-1234-abcd-123456789012",
"address": {
"salutation": "Mr.",
"firstName": "Sherlock",
"surName": "Holmes",
"street1": "221B Baker Street",
"street2": "Marylebone",
"postalCode": "NW1 6XE",
"city": "London",
"county": "N/A",
"country": "GB",
"telephoneNumber": "02072243688",
"company": "",
"locationType": 0
},
"circulation": 1,
"delivery": {
"type": 0,
"carrier": "Interlink",
"serviceType": "DPD Next day",
"serviceDescription": "DPD Next day",
"canonicalUri": "DPD-DPD_NEXT_DAY-zxa-1",
"cost": 6.5,
"url": "https://mixam.co.uk/spedition/1234567890abcdefghijklmn"
},
"dispatchDate": 1603234800000,
"deliveryDate": 1603321200000
}
],
"senderForLabel": {
"salutation": "Mr.",
"firstName": "Arthur",
"surName": "Conan Doyle",
"street1": "6 Hercules Way, Watford, Hertfordshire, WD25 7GS",
"postalCode": "WD25 7GS",
"city": "Watford",
"county": "Hertfordshire",
"country": "GB",
"telephoneNumber": "01923 594 040",
"email": "info@mixam.co.uk",
"company": "Mixam Print"
},
"weight": 1.7999999523162842,
"units": 0
}
},
"export": {
"customsValueSum": 33.16999816894531,
"customsValueCurrency": "GBP"
},
"price": 33.16999816894531,
"currencyCode": "GBP"
}<MxJdf4>
<version>4.01</version>
<desc>mixam.job.description</desc>
<referencedJobNumber>37663402</referencedJobNumber>
<author>Sherlock Holmes</author>
<dateCreated>1603279655663</dateCreated>
<job>
<article>
<components-list>
<components>
<pages>28</pages>
<chromaticity>
<front>3</front>
<back>3</back>
</chromaticity>
<format>
<longEdge>210.0</longEdge>
<orientation>1</orientation>
<shortEdge>148.0</shortEdge>
<units>0</units>
</format>
<material>
<weight>150</weight>
<units>1</units>
<refinings-list/>
<type>1</type>
<color>0</color>
</material>
<processing>
<binding>
<type>1</type>
<spineWidth>0.0</spineWidth>
</binding>
</processing>
<type>1</type>
<files-list>
<files>
<type>1</type>
<name>job123456.pdf</name>
<url>https://s3.wasabisys.com/files.mixam.com/8472912a7dba3e57ddeb36131ae96726ff3cc5da/job376634.pdf</url>
<checksum>584f4618c4532fbacda1d36d8a0d8338</checksum>
<sizeInBytes>11437989</sizeInBytes>
</files>
</files-list>
</components>
</components-list>
<type>0</type>
<product>1</product>
<subProduct>0</subProduct>
<rightToLeft>false</rightToLeft>
<productionDays>3</productionDays>
</article>
<details>
<additionalProjectName>5e31a3dc2f231530f33ef3a4</additionalProjectName>
<completionType>2</completionType>
<totalCirculation>250</totalCirculation>
<assumedPrintType>3</assumedPrintType>
<orderId>1234567890abcdefghijklmn</orderId>
</details>
<shipment>
<deliveryAddresses-list>
<deliveryAddresses>
<deliveryId>12345678-abcd-1234-abcd-123456789012</deliveryId>
<address>
<salutation>Mr.</salutation>
<firstName>Sherlock</firstName>
<surName>Holmes</surName>
<street1>221B Baker Street</street1>
<street2></street2>
<postalCode>NW16XE</postalCode>
<city>Marylebone</city>
<county>London</county>
<country>GB</country>
<telephoneNumber>01225485600</telephoneNumber>
<company>Interaction</company>
<locationType>0</locationType>
</address>
<circulation>250</circulation>
<delivery>
<type>0</type>
<carrier>Interlink</carrier>
<serviceType>DPD Next day</serviceType>
<serviceDescription>DPD Next day</serviceDescription>
<canonicalUri>DPD-DPD_NEXT_DAY-zxa-1</canonicalUri>
<cost>8.39</cost>
</delivery>
<dispatchDate>1580428800000</dispatchDate>
<deliveryDate>1580688000000</deliveryDate>
</deliveryAddresses>
</deliveryAddresses-list>
<senderForLabel>
<salutation>Mr.</salutation>
<firstName>Arthur</firstName>
<surName>Conan Doyle</surName>
<street1>6 Hercules Way, Watford, Hertfordshire, WD25 7GS</street1>
<postalCode>WD25 7GS</postalCode>
<city>Watford</city>
<county>Hertfordshire</county>
<country>GB</country>
<telephoneNumber>01923 594 040</telephoneNumber>
<email>info@mixam.co.uk</email>
<company>Mixam Print</company>
</senderForLabel>
<weight>16.299999237060547</weight>
<units>0</units>
</shipment>
</job>
<export>
<customsValueSum>143.85000610351562</customsValueSum>
<customsValueCurrency>GBP</customsValueCurrency>
</export>
<price>143.85000610351562</price>
<currencyCode>GBP</currencyCode>
</MxJdf4>The Mixam Job Description Format is an Open Source software released under the Apache 2.0 license.