PRINTFLOW API DESCRIPTION
v 1.3
Introduction
System access
API URL: https://printflow.lynka.eu/en/api/v2019-06/
To access the API, one needs to authenticate using an individual X-Api-Key header.
Methods
1. Creating orders
POST https://printflow.lynka.eu/en/api/v2019-06/orders.json
Example JSON body:
{
"id": "638392", // your order id
"address_to": { // delivery address
"address1": "1234 address1 line",
"address2": "",
"city": "EXAMPLE",
"zip": "31345",
"country": "US",
"region": "NY",
"first_name": "john",
"last_name": "smith",
"email": "john.smith@example.com",
"phone": "3312312231"
},
"address_from": { // dispatch address
"address1": "1234 address1 line",
"address2": "",
"city": "EXAMPLE",
"zip": "31345",
"country": "US",
"region": "NY",
"company": "T-Shirt Company",
"email": "company@example.com",
"phone": "6512312231"
},
"delivery_note": "..." // base64 encoded PDF for the delivery note
"shipping": { // shipping method
"carrier": "UPS",
"priority": "Express"
},
"items": [ // definition of items in the order
{
"id": "44", // your order item id
"sku": "3001-BLACK-L", // blank item SKU
"preview_files": { // mockup URLs
"front": "https://images.yaxint.com/mockup/front-url.jpeg",
"back": "https://images.yaxint.com/mockup/back-url.jpeg"
},
"print_files": { // print file URLs
"front": "https://images.yaxint.com/print/front-url.jpeg",
"back": "https://images.yaxint.com/print/back-url.jpeg",
"left_sleeve":
"https://images.yaxint.com/print/left_sleeve-url.jpeg"
},
"quantity": 1
},
{
"id": "46",
"sku": "3000-RED-L",
"preview_files": {
"front": "https://images.yaxint.com/mockup/front-url.jpeg",
"back": "https://images.yaxint.com/mockup/back-url.jpeg"
},
"print_files": {
"front": "https://images.yaxint.com/print/front-url.jpeg"
},
"quantity": 2
}
]
}
2. Fetching orders
GET https://printflow.lynka.eu/en/api/v2019-06/order/[your_order_id].json
Example response:
{
"id": "638392", // your order id
"address_to": { // delivery address
"address1": "1234 address1 line",
"address2": "",
"city": "EXAMPLE",
"zip": "31345",
"country": "US",
"region": "NY",
"first_name": "john",
"last_name": "smith",
"email": "john.smith@example.com",
"phone": "3312312231"
},
"address_from": { // dispatch address
"address1": "1234 address1 line",
"address2": "",
"city": "EXAMPLE",
"zip": "31345",
"country": "US",
"region": "NY",
"company": "T-Shirt Company",
"email": "company@example.com",
"phone": "6512312231"
},
"delivery_note": "..." // base64 encoded PDF for the delivery note
"shipping": { // shipping method
"carrier": "UPS",
"priority": "Express"
},
"items": [ // definition of items in the order
{
"id": "44", // your order item id
"sku": "3001-BLACK-L", // blank item SKU
"preview_files": { // mockup URLs
"front": "https://images.yaxint.com/mockup/front-url.jpeg",
"back": "https://images.yaxint.com/mockup/back-url.jpeg"
},
"print_files": { // print file URLs
"front": "https://images.yaxint.com/print/front-url.jpeg",
"back": "https://images.yaxint.com/print/back-url.jpeg",
"left_sleeve":
"https://images.yaxint.com/print/left_sleeve-url.jpeg"
},
"quantity": 1
},
{
"id": "46",
"sku": "3000-RED-L",
"preview_files": {
"front": "https://images.yaxint.com/mockup/front-url.jpeg",
"back": "https://images.yaxint.com/mockup/back-url.jpeg"
},
"print_files": {
"front": "https://images.yaxint.com/print/front-url.jpeg"
},
"quantity": 2
}
]
}
3. Fetching order events
GET https://printflow.lynka.eu/en/api/v2019-06/order/[your_order_id]./events.json
Example response:
{
"status": "shipped",
"tracking": "JJD000030160301000000012760",
"courier": "DHL_PARCEL",
"tracking_pdf": "..." // base64 encoded PDF for the shipping label
}