API Dokumentation

REST API

Authorization

our base URL is: api.tdeu.de


Content-Type: application/json


X-API-Key: 1234567-XXXX-XXXXX-XXXX-XXXXXXXXXXX


ClientSecret: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX


POST Order

Route: v2019-10/orders

Request Parameters

Please note: if you do not want to fill in some fields, please submit an empty string and do not leave out the whole object!

order_number string (min length: 3; max length:45); forbidden characters:

#

;

:

.

,

"

'

mandatory Order number
creation_date DateTime
mandatory time that order was received at
currency string (max length: 3); Default: EUR, other see: ISO 4217
forbidden characters:

"

'

currency
allow_partial_delivery bool (default: false)
partial delivery allowed true/false
delivery_service long (max length: 4)
Delivery Service ID information
order_packing_sku string (max length: 45); forbidden characters:

"

'

special packaging for the whole order, requires further clarification and prior consultation
address_delivery
mandatory delivery address
salutation string (max length: 25); forbidden characters:

"

'

salutation
company string (max length: 50); forbidden characters:

"

'

mandatory if no first_name/last_name is specified company name
first_name string (field lengths); forbidden characters:

"

'

0-9

mandatory if no company is specified first name
last_name string (field lengths); forbidden characters:

"

'

0-9

mandatory if no company is specified last name
care_of string (max length: 35
care of
street string (max length: 35); forbidden characters:

"

'

mandatory street name
street_number string (max length: 10); forbidden characters:

"

'

mandatory street number
zip_code string (max length: 10); forbidden characters:

"

'

mandatory zip code
city string (max length: 35); forbidden characters:

"

'

mandatory city name
state string (max length: 10); forbidden characters:

"

'

state
country string (max length: 2) see ISO-3166 Alpha 2 forbidden characters:

"

'

0-9

mandatory country
phone string (max length: 20); forbidden characters:

"

'

phone number
email string (max length: 70); forbidden characters:

"

'

E-Mail Address
address_sender
mandatory sender address, needs to be a german address. if you do not have a german address, see sender address information
salutation string (max length: 25); forbidden characters:

"

'

salutation
company string (max length: 50); forbidden characters:

"

'

mandatory if no first_name/last_name is specified company name
first_name string (field lengths); forbidden characters:

"

'

0-9

mandatory if no company is specified first name
last_name string (field lengths); forbidden characters:

"

'

0-9

mandatory if no company is specified last name
care_of string (max length: 35); forbidden characters:

"

'

care of
street string (max length: 35); forbidden characters:

"

'

mandatory street name
street_number string (max length: 10); forbidden characters:

"

'

mandatory street number
zip_code string (max length: 10); forbidden characters:

"

'

mandatory zip code
city string (max length: 35); forbidden characters:

"

'

mandatory city name
state string (max length: 10); forbidden characters:

"

'

state
country string (max length: 2) ISO-3166 Alpha 2 forbidden characters:

"

'

0-9

mandatory country
phone string (max length: 20); forbidden characters:

"

'

phone number
email string (max length: 70); forbidden characters:

"

'

E-Mail Address
address_bill
bill address
salutation string (max length: 25); forbidden characters:

"

'

salutation
company string (max length: 50); forbidden characters:

"

'

mandatory if no first_name/last_name is specified company name
first_name string (field lengths); forbidden characters:

"

'

0-9

mandatory if no company is specified first name
last_name string (field lengths); forbidden characters:

"

'

0-9

mandatory if no company is specified last name
care_of string (max length: 35); forbidden characters:

"

'

care of
street string (max length: 35); forbidden characters:

"

'

mandatory street name
street_number string (max length: 10); forbidden characters:

"

'

mandatory street number
zip_code string (max length: 10); forbidden characters:

"

'

mandatory zip code
city string (max length: 35); forbidden characters:

"

mandatory city name
state string (max length: 10); forbidden characters:

"

'

state
country string (max length: 2) ISO-3166 Alpha 2 forbidden characters:

"

'

0-9

mandatory country
phone string (max length: 20); forbidden characters:

"

'

phone number
email string (max length: 70); forbidden characters:

"

'

E-Mail Address
positions (Array)
mandatory order positions
positions_packing_sku string ( max length: 45); forbidden characters:

"

'

special packaging for the individual position, requires further clarification and prior consultation
order_item_id string ( max length: 35); forbidden characters:

"

'

one-to-one id of your position-database, generated automatically if not specified
quantity int (max length: 9); forbidden characters:

everything other than numeric

mandatory quantity
price_duty double; forbidden characters:

everything other than numeric

mandatory when outside EU price duty
sku string (max length: 35); forbidden characters:

"

'

customer sku
name string (max length: 35); forbidden characters:

"

'

sku name
base_article
article_number string (max length: 35); forbidden characters:

"

'

mandatory article number / product number, you can find the complete list of products in our ProductList
images (Array)
Image Information
side string (max length: 3); forbidden characters:

"

'

mandatory for further information see Printing Areas
printing_type long (max length: 4)
mandatory for further information see Printing Types
image_url string (max length: 1000); forbidden characters:

"

'

mandatory URL, Print-document only! allowed extensions: see Printing types
preview_url string (max length: 1000); forbidden characters:

"

'

optional URL, Preview-document; allowed extensions:

PNG

JPG

GIF

Responses

This section contains possible responses and further defines the response schema

200

OK

Response schema

JSON

{"Message":"Order recived and stored with Id=1460XXX"}

304

not modified

Response schema

JSON

{"Message":"The request has already been received (order exists)"}

400

bad request

Response schema

JSON

{"Message":"will contain further status information"}

Packstation

If you want to send Orders to a Packstation you need to pay attention to special features.


street

: "Packstation"


street_number

: The Number of the Packstation


care_of

: Postnummer


zip_code

: zip-code of the Packstation


city

: city of the Packstation


all packing stations can be found at

Standortfinder

German Sender Address

If you do not have a german address to send your packages from, you can use our address as following:


company

: your company name


street

: Grenzstraße


street_number

: 15


zip_code

: 06112


city

: Halle


Field Lengths

last_name

:3-35 characters (last_name + first_name)


first_name

:3-35 characters (last_name + first_name)


Printing Types

Here you can find a summary of possible printing types

printing_type ID printing_type description max size [X;Y] Resolution extension
0 unprinted textiles see our FAQ
2 Digital Inkjet printing, on demand [4547px;5315px] 300dpi PNG, TIF, TIFF
4 Foils Foils, on demand [38.5cm;49cm] vektor Vektor, ai, cdr, eps
32 Sublimation Sublimation, on demand [11811px;11811px] 300dpi PNG, TIF, TIFF
256 ScreenPrint Serial screen print [4724px;6378px] 300dpi PNG, TIF, TIFF, Vektor, ai, cdr, eps
512 Embroidery Embroidery, on demand PNG, TIF, TIFF, Vektor, ai, cdr, eps
128 Laser Laser, on demand PNG, TIF, TIFF, Vektor, ai, cdr, eps
70 paper inlay paper inlay, on demand [969px/82mm;909px/77mm] 300dpi PDF

Image Information

for printing types 2, 32, 256

Best results with following settings (Adobe Photoshop)

Image compression

: LZW


Save transparency

: yes


pixel arrangement

: Interleaved (RGBRGB)


Byte order

: IBM PC


Layer compression

: RLE


for printing type 4

must be vector graphic

for printing types 128, 512

see printing type 2 or 4

Printing Areas

Here you can find a summary of possible printing areas

side description
BM chest middle
RM back middle
AL left arm
AR right arm
NI neck inside
NA neck outside

Delivery Service IDs

Here you can find information about the possible delivery service IDs

If you prefer one of our optional services, it is mandatory that you submit the service ID

If you do not submit an ID, we will automatically assign a fitting delivery service, depending on the country code, of our standard services

ID description standard / optional
11 DHL package, up to 2kg, only when delivery country = DE standard
34 DHL Warenpost Premium International, up to 1 kg standard
32 DHL Warenpost, up to 1kg, only when delivery country = DE optional

POST

https://api.tdeu.de/v2019-10/orders

Request Sample

Content type

application/json

{

"order_number": "123456",

"creation_date": "2022-01-17T08:40:17",

"currency": "EUR",

"allow_partial_delivery": false,

"delivery_service": 7,

"order_packing_sku": "Carton No 1",

"address_delivery": {

"salutation": "Frau",

"company": "",

"first_name": "Erika",

"last_name": "Mustermann",

"care_of": "",

"street": "Heidestrasse",

"street_number": "17",

"zip_code": "51147",

"city": "Köln",

"state": "",

"country": "DE",

"phone": "0123 45678910",

"email": "erika.mustermann@muster.de"

},

"address_sender": {

"salutation": "Frau",

"company": "",

"first_name": "Erika",

"last_name": "Mustermann",

"care_of": "",

"street": "Heidestrasse",

"street_number": "17",

"zip_code": "51147",

"city": "Köln",

"state": "",

"country": "DE",

"phone": "0123 45678910",

"email": "erika.mustermann@muster.de"

},

"address_bill": {

"salutation": "Frau",

"company": "",

"first_name": "Erika",

"last_name": "Mustermann",

"care_of": "",

"street": "Heidestrasse",

"street_number": "17",

"zip_code": "51147",

"city": "Köln",

"state": "",

"country": "DE",

"phone": "0123 45678910",

"email": "erika.mustermann@muster.de"

},

"positions": [

{

"positions_packing_sku": "Carton No 2",

"order_item_id": "2089",

"quantity": 2,

"price_duty": 14.46,

"sku": "188421016",

"name": "Exact 190/kids T-Shirt",

"base_article": {

"article_number": "019421015"

},

"images": [

{

"side": "RM",

"printing_type": 2,

"image_url": "c:/Users/Folder/Image.tif",

"preview_url": "c:/Users/Folder/Image2.jpg",

}

]}

]}

Response Sample

Content type

application/json

200

{"Message":"Order recived and stored with Id=1460XXX"}


304

{"Message":"The request has already been received (order exists)"}


400

{"Message":"first_name + last_name is limited to 35 characters"}


GET Order

Route: v2019-10/orders/{orderNumber}


Request Parameters (field parameters see POST Order)

order_number string
order number

Responses

This section contains possible responses and further defines the response schema

200

OK

Response schema (field parameters see POST Order)

id long
ID
order_number string
order number
customer_id int
internal customer ID
creation_date DateTime
time that order was received at
insert_date DateTime
post order date
currency string
currency
allow_partial_delivery bool
partial delivery allowed true/false
is_reclamation bool
is it a reclamation true/false
delivery_service
delivery information
name string
service name
carrier string
carrier name
type long
delivery_service id
address_delivery
delivery address
salutation string
salutation
first_name string
first name
last_name string
last name
street string
street name
street_number string
street number
zip_code string
zip code
city string
city name
country string
country
address_sender
sender address
salutation string
salutation
first_name string
first name
last_name string
last name
street string
street name
street_number string
street number
zip_code string
zip code
city string
city name
country string
country
positions (Array)
Order positions
{
id long
internal ID
position_number long
order_item_id string
ID of specific Item
name string
sku name
sku string
quantity long
complete_date DateTime
Time order was completed
is_on_demand bool
is it an on-demand order true/false
price_duty double
price duty
base_Article
Information about the base article
article_number string
article number
article_name string
article name
manufacturer string
manufacturer of the base article
hs_code string
hs code
size string
size of the base article
color string
color of the base article
color_code string
manufacturer color code
origin_country string
the country where the article originated from
weight integer
weight of the article
images
Information about the images
side string
side where printing is supposed to be
printing_type long
print_size_x int
width in px
print_size_y int
height in px
dpi int
dpi
events (Array)
Order events
{ label_created
name (=label_created)
name
time DateTime
time
{ tracking_created
name (=trackinig_created)
name
time DateTime
time
shipping_id string
shipping ID
address_delivery
delivery address
salutation string
salutation
first_name string
first name
last_name string
last name
street string
street name
street_number string
street number
zip_code string
zip code
city string
city
country string
country
address_sender
salutation string
salutation
first_name string
first name
last_name string
last name
street string
street name
street_numbe string
street number
zip_code string
zip code
city string
city
country string
country
shipping_provider string
shipping provider
carrier string
carrier
tracking_number string
tracking number
tracking_service string
tracking service
positions
position int
position number
quantity long
quantity of the position articles
{ transit
name (= transit)
name
time DateTime
time
{ notification
name (= notification)
name
time DateTime
time
{ delayed
name (=delayed)
name
time DateTime
time
{ out_for_delivery
name (= out_for_delivery)
name
time DateTime
time
{ delivered
name (= delivered)
name
time DateTime
time

400

bad request

Response schema

JSON

{"Message":"will contain further status information"}

GET

https://api.tdeu.de/v2019-10/orders/{orderNumber}

Request Sample

Content type

application/json


https://api.tdeu.de/v2019-10/orders/12345678


Response Sample

Content type

application/json

200

{

"id": 1634567,

"order_number": "306XXX",

"customer_id": 123,

"creation_date": "2022-01-17T08:40:17",

"insert_date": "2022-01-17T08:46:14.08937",

"currency": "EUR",

"allow_partial_delivery": false,

"is_reclamation": false,

"delivery_service": {

"id": 19,

"name": "DHL Paket bis 2kg",

"carier": "DHL",

"type": "Paket"

},

"address_delivery": {

"salutation": "Firma",

"first_name": "Beispielfirma.com",

"last_name": "Inh. Erika Mustermann",

"street": "Heidestrasse",

"street_number": "17",

"zip_code": "51147",

"city": "Köln",

"country": "DE"

},

"address_sender": {

"salutation": "Firma",

"first_name": "Beispielfirma.com",

"last_name": "Inh. Erika Mustermann",

"street": "Heidestrasse",

"street_number": "17",

"zip_code": "51147",

"city": "Köln",

"country": "DE"

},

"positions": [ {

"id": 1285260,

"position_number": 1,

"order_item_id": "1234",

"name": "Neu 2022-01-17 08:36",

"sku": "188421015",

"quantity": 1,

"complete_date": "2022-02-03T18:06:01",

"is_on_demand": true,

"price_duty": 14.46,

"base_article": {

"article_number": "188421015",

"article_name": "Exact 190/kids T-Shirt",

"manufacturer": "B & C",

"hs_code": "61091000",

"size": "7/8 (122/128)",

"color": "Black",

"color_code": "101",

"origin_country": "BD",

"weight": 100

},

"images": [

{

"side": "BM",

"printing_type": 2,

"print_size_x": 2300,

"print_size_y": 3000,

"dpi": 300

} ]

},

{

"id": 1285261,

"position_number": 2,

"order_item_id": "2090",

"name": "Neu 2022-01-17 08:36",

"sku": "188421016",

"quantity": 1,

"quantity_original": 1,

"complete_date": "2022-02-03T18:05:39",

"is_on_demand": true,

"price_duty": 14.46,

"base_article": {

"article_number": "188421016",

"article_name": "Exact 190/kids T-Shirt",

"manufacturer": "B & C",

"hs_code": "61091000",

"size": "9/11 (134/146)",

"color": "Black",

"color_code": "101",

"origin_country": "BD",

"weight": 120

},

"images": [{

"side": "BM",

"printing_type": 2,

"print_size_x": 2300,

"print_size_y": 3000,

"dpi": 300

} ] } ],

"events": [

{

"name": "label_created",

"time": "2022-02-03T18:06:15+01:00",

},

{

"name": "tracking_created",

"time": "2022-02-03T18:06:24",

"shipping_id": "3d7710c26e8ff5df66f820ac09aXXXXXXXXXXXXX",

"address_delivery": {

"salutation": "Firma",

"first_name": "Beispielfirma.com",

"last_name": "Inh. Erika Mustermann",

"street": "Heidestrasse",

"street_number": "17",

"zip_code": "51147",

"city": "Köln",

"country": "DE"

},

"address_sender": {

"salutation": "Firma",

"first_name": "Beispielfirma.com",

"last_name": "Inh. Erika Mustermann",

"street": "Heidestrasse",

"street_number": "17",

"zip_code": "51147",

"city": "Köln",

"country": "DE"

},

"shipping_provider": "ShipCloud",

"carrier": "dhl",

"tracking_number": "003404346512403XXXXX",

"tracking_service": "standard",

"positions": [

{

"position": "1:2089",

"quantity": 1

},

{

"position": "2:2090",

"quantity": 1

}

] },

{

"name": "transit",

"time": "2022-02-04T18:41:00+01:00",

},

{

"name": "notification",

"time": "2022-02-04T19:09:00+01:00"

},

{

"name": "delayed",

"time": "2022-02-05T08:21:00+01:00",

},

{

"name": "out_for_delivery",

"time": "2022-02-07T07:43:00+01:00"

},

{

"name": "delivered",

"time": "2022-02-07T11:00:00+01:00",

},

]

}

400

{"Message":"first_name + last_name is limited to 35 characters"}


GET events

Route: v2019-10/orders/{orderNumber}/events

Request Parameters

order_number string (min length: 3; max length:45)
mandatory Order number

Responses

This section contains possible responses and further defines the response schema

200

OK

Response schema (field parameters see POST Order)

{ label_created
name (=label_created)
name
time DateTime
time
{ tracking_created
name (=trackinig_created)
name
time DateTime
time
shipping_id string
shipping ID
address_delivery
delivery address
salutation string
salutation
first_name string
first name
last_name string
last name
street string
street name
street_number string
street number
zip_code string
zip code
city string
city
country string
country
address_sender
salutation string
salutation
first_name string
first name
last_name string
last name
street string
street name
street_numbe string
street number
zip_code string
zip code
city string
city
country string
country
shipping_provider string
shipping provider
carrier string
carrier
tracking_number string
tracking number
tracking_service string
tracking service
positions
position int
position number
quantity long
quantity of the position articles
{ transit
name (= transit)
name
time DateTime
time
{ notification
name (= notification)
name
time DateTime
time
{ delayed
name (=delayed)
name
time DateTime
time
{ out_for_delivery
name (= out_for_delivery)
name
time DateTime
time
{ delivered
name (= delivered)
name
time DateTime
time

400

bad request

Response schema

JSON

{"Message":"will contain further status information"}

GET

https://api.tdeu.de/v2019-10/orders/{orderNumber}/events

Request Sample

Content type

application/json

https://api.tdeu.de/v2019-10/orders/1234567/events

Response Sample

Content type

application/json

200

[

{

"name": "label_created",

"time": "2022-02-03T18:06:15+01:00",

},

{

"name": "tracking_created",

"time": "2022-02-03T18:06:24",

"shipping_id": "3d7710c26e8ff5df66f820ac09aXXXXXXXXXXXXX",

"address_delivery": {

"salutation": "Firma",

"first_name": "Beispielfirma.com",

"last_name": "Inh. Erika Mustermann",

"street": "Heidestrasse",

"street_number": "17",

"zip_code": "51147",

"city": "Köln",

"country": "DE"

},

"address_sender": {

"salutation": "Firma",

"first_name": "Beispielfirma.com",

"last_name": "Inh. Erika Mustermann",

"street": "Heidestrasse",

"street_number": "17",

"zip_code": "51147",

"city": "Köln",

"country": "DE"

},

"shipping_provider": "ShipCloud",

"carrier": "dhl",

"tracking_number": "003404346512403XXXXX",

"tracking_service": "standard",

"positions": [

{

"position": "1:2089",

"quantity": 1

},

{

"position": "2:2090",

"quantity": 1

}

] },

{

"name": "transit",

"time": "2022-02-04T18:41:00+01:00",

},

{

"name": "notification",

"time": "2022-02-04T19:09:00+01:00"

},

{

"name": "delayed",

"time": "2022-02-05T08:21:00+01:00",

},

{

"name": "out_for_delivery",

"time": "2022-02-07T07:43:00+01:00"

},

{

"name": "delivered",

"time": "2022-02-07T11:00:00+01:00",

},

]

400

{"Message":"first_name + last_name is limited to 35 characters"}


GET stock

Route: v2019-10/stock/{sku}

Request Parameters

sku string (max length: 35)
mandatory customer sku

Responses

This section contains possible responses and further defines the response schema

200

OK

Response schema

JSON

{sku:stock quantity}

503

service unavailable

Response schema

JSON

{"Message":"will contain further status information"}

GET

https://api.tdeu.de/v2019-10/stock/{sku}

Request Sample

Content type

application/json

https://api.tdeu.de/v2019-10/stock/019421015


Response Sample

Content type

application/json

200

{"019421015":35}


503

{"Message":""}


POST Cancel Order

Route: v2019-10/order/{orderNumber}/cancel

order_number string (min length: 3; max length:45)
mandatory Order number

Responses

This section contains possible responses and further defines the response schema

200

OK

Response schema

JSON

"{"Message":"Order is cancelled. order_number: 123456 "}"

400

bad request

Response schema

JSON

{"Message":"will contain further status information"}

409

conflict

Response schema

JSON

{"Message":"Order is already in production. Cancellation is not allowed."}

POST

https://api.tdeu.de/v2019-10/order/{OrderNumber}/cancel

Request Sample

Content type

application/json

https://api.tdeu.de/v2019-10/order/123456/cancel

Response Sample

Content type

application/json

200

{"Message":"Order is cancelled. order_number: 123456 "}

400

{"Message":"will contain further status information"}

409

{"Message":"Order is already in production. Cancellation is not allowed."}