CloudSignal API
This documentation describes the CloudSignal API v2.0
Getting started
To get started with Cloudprinter as a Print Partner please read the "Getting started as a Print Partner" article.
Online sign up as a Print Partner is found here: Sign up a Print Partner
Basics
RESTful API
The CloudSignal API is RESTful. All API calls are implemented as HTTP post requests.
Request Data
All request data posted to the API must be in JSON objects. The documentation for each API call describes the request data parameters in detail.
Return Data
In case on a HTTP response code 400 the return data can contain an error message. In all other cases the return data is not used.
HTTP response code
The HTTP response code 200 is a positive responses, all other response codes must be considered as error.
Content-type
Set content-type to application/json on all requests.
Authentication
Authentication on the CloudSignal API is done via the API key. The API key is generated by the Cloudprinter system when you create the CloudSignal API Interface in the admin panel.
Please note: The API key for signals is not the same API key as for incoming orders.
Signal types
ItemRegistered
endpoint
https://api.cloudprinter.com/cloudsignal/2.0/status/1
Production has started for item.
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemRegistered",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}1
2
3
4
5
6
7
2
3
4
5
6
7
js
const axios = require('axios');
const data = JSON.stringify({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemRegistered",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
);
const config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
headers: {
'Content-Type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error);
});1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemRegistered",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
py
import requests
import json
url = "https://api.cloudprinter.com/cloudsignal/2.0/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemRegistered",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
)
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
sh
curl --location 'https://api.cloudprinter.com/cloudsignal/2.0/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemRegistered",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
'1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| apikey | string | api access key | required |
| type | string | valid value: ItemRegistered | required |
| order | string | the full order id | required |
| item | string | the full item id | required |
| datetime | string | timestamp | required |
| Code | Status | Description |
|---|---|---|
| 200 | OK | the request has succeeded |
| 400 | Bad request | the request was invalid or parameters are missing |
| 401 | Unauthorized | authentication failed |
| 403 | Forbidden | authentication failed |
ItemProduce
endpoint
https://api.cloudprinter.com/cloudsignal/2.0/status/1
Production has started for item.
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemProduce",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}1
2
3
4
5
6
7
2
3
4
5
6
7
js
const axios = require('axios');
const data = JSON.stringify({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemProduce",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
);
const config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
headers: {
'Content-Type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error);
});1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemProduce",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
py
import requests
import json
url = "https://api.cloudprinter.com/cloudsignal/2.0/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemProduce",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
)
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
sh
curl --location 'https://api.cloudprinter.com/cloudsignal/2.0/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemProduce",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
'1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| apikey | string | api access key | required |
| type | string | valid value: ItemProduce | required |
| order | string | the full order id | required |
| item | string | the full item id | required |
| datetime | string | timestamp | required |
| Code | Status | Description |
|---|---|---|
| 200 | OK | the request has succeeded |
| 400 | Bad request | the request was invalid or parameters are missing |
| 401 | Unauthorized | authentication failed |
| 403 | Forbidden | authentication failed |
ItemProduced
endpoint
https://api.cloudprinter.com/cloudsignal/2.0/status/1
Production completed for item.
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemProduced",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}1
2
3
4
5
6
7
2
3
4
5
6
7
js
const axios = require('axios');
const data = JSON.stringify({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemProduced",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
);
const config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
headers: {
'Content-Type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error);
});1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemProduced",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
py
import requests
import json
url = "https://api.cloudprinter.com/cloudsignal/2.0/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemProduced",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
)
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
sh
curl --location 'https://api.cloudprinter.com/cloudsignal/2.0/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemProduced",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
'1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| apikey | string | api access key | required |
| type | string | valid value: ItemProduced | required |
| order | string | the full order id | required |
| item | string | the full item id | required |
| datetime | string | timestamp | required |
| Code | Status | Description |
|---|---|---|
| 200 | OK | the request has succeeded |
| 400 | Bad request | the request was invalid or parameters are missing |
| 401 | Unauthorized | authentication failed |
| 403 | Forbidden | authentication failed |
ItemPacked
endpoint
https://api.cloudprinter.com/cloudsignal/2.0/status/1
Item has been packed.
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemPacked",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}1
2
3
4
5
6
7
2
3
4
5
6
7
js
const axios = require('axios');
const data = JSON.stringify({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemPacked",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
);
const config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
headers: {
'Content-Type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error);
});1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemPacked",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
py
import requests
import json
url = "https://api.cloudprinter.com/cloudsignal/2.0/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemPacked",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
)
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
sh
curl --location 'https://api.cloudprinter.com/cloudsignal/2.0/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemPacked",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
}
'1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| apikey | string | api access key | required |
| type | string | valid value: ItemPacked | required |
| order | string | the full order id | required |
| item | string | the full item id | required |
| datetime | string | timestamp | required |
| Code | Status | Description |
|---|---|---|
| 200 | OK | the request has succeeded |
| 400 | Bad request | the request was invalid or parameters are missing |
| 401 | Unauthorized | authentication failed |
| 403 | Forbidden | authentication failed |
ItemShipped
endpoint
https://api.cloudprinter.com/cloudsignal/2.0/status/1
Item has been shipped. The tracking code for the packet is included in this signal.
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemShipped",
"order": "123456780000",
"item": "123456780001",
"tracking": "1A2B3C4D5E6F",
"shipping_option": "GLS",
"datetime": "2016-01-20 13:00:00 GMT"
}1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
js
const axios = require('axios');
const data = JSON.stringify({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemShipped",
"order": "123456780000",
"item": "123456780001",
"tracking": "1A2B3C4D5E6F",
"shipping_option": "GLS",
"datetime": "2016-01-20 13:00:00 GMT"
}
);
const config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
headers: {
'Content-Type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error);
});1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemShipped",
"order": "123456780000",
"item": "123456780001",
"tracking": "1A2B3C4D5E6F",
"shipping_option": "GLS",
"datetime": "2016-01-20 13:00:00 GMT"
}
',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
py
import requests
import json
url = "https://api.cloudprinter.com/cloudsignal/2.0/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemShipped",
"order": "123456780000",
"item": "123456780001",
"tracking": "1A2B3C4D5E6F",
"shipping_option": "GLS",
"datetime": "2016-01-20 13:00:00 GMT"
}
)
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
sh
curl --location 'https://api.cloudprinter.com/cloudsignal/2.0/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemShipped",
"order": "123456780000",
"item": "123456780001",
"tracking": "1A2B3C4D5E6F",
"shipping_option": "GLS",
"datetime": "2016-01-20 13:00:00 GMT"
}
'1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| apikey | string | api access key | required |
| type | string | valid value: ItemShipped | required |
| order | string | the full order id | required |
| item | string | the full item id | required |
| tracking | string | tracking code for the item | required |
| shipping_option | string | shipping option | required |
| datetime | string | timestamp | required |
| Code | Status | Description |
|---|---|---|
| 200 | OK | the request has succeeded |
| 400 | Bad request | the request was invalid or parameters are missing |
| 401 | Unauthorized | authentication failed |
| 403 | Forbidden | authentication failed |
ItemDelay
endpoint
https://api.cloudprinter.com/cloudsignal/2.0/status/1
Item has an error during production, this could be a print error, cutting error, failed quality control etc., something the production can recover from, but it will cause a delay in production.
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemDelay",
"order": "123456780000",
"item": "123456780001",
"cause": "Print error, reprint needed",
"delay": "24",
"datetime": "2016-01-20 13:00:00 GMT"
}1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
js
const axios = require('axios');
const data = JSON.stringify({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemDelay",
"order": "123456780000",
"item": "123456780001",
"cause": "Print error, reprint needed",
"delay": "24",
"datetime": "2016-01-20 13:00:00 GMT"
}
);
const config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
headers: {
'Content-Type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error);
});1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemDelay",
"order": "123456780000",
"item": "123456780001",
"cause": "Print error, reprint needed",
"delay": "24",
"datetime": "2016-01-20 13:00:00 GMT"
}
',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
py
import requests
import json
url = "https://api.cloudprinter.com/cloudsignal/2.0/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemDelay",
"order": "123456780000",
"item": "123456780001",
"cause": "Print error, reprint needed",
"delay": "24",
"datetime": "2016-01-20 13:00:00 GMT"
}
)
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
sh
curl --location 'https://api.cloudprinter.com/cloudsignal/2.0/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemDelay",
"order": "123456780000",
"item": "123456780001",
"cause": "Print error, reprint needed",
"delay": "24",
"datetime": "2016-01-20 13:00:00 GMT"
}
'1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| apikey | string | api access key | required |
| type | string | valid value: ItemDelay | required |
| order | string | the full order id | required |
| item | string | the full item id | required |
| cause | string | text string explaining the error | optional |
| delay | string | expected delay in hours | optional |
| datetime | string | timestamp | required |
| Code | Status | Description |
|---|---|---|
| 200 | OK | the request has succeeded |
| 400 | Bad request | the request was invalid or parameters are missing |
| 401 | Unauthorized | authentication failed |
| 403 | Forbidden | authentication failed |
ItemError
endpoint
https://api.cloudprinter.com/cloudsignal/2.0/status/1
Alias of the ItemDelay signal. The ItemError will be deprecated in future versions of the protocol. See ItemDelay.
ItemCanceled
endpoint
https://api.cloudprinter.com/cloudsignal/2.0/status/1
The cause must be specified as precise as possible. A custom messages is accepted and is recommended so the client can get a better idea about the nature of the issue.
Accepted cancellation causes can be found here: Print partner cancellation causes
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemCanceled",
"order": "123456780000",
"item": "123456780001",
"cause": "CancelBookSize",
"message": "Book has wrong width",
"datetime": "2016-01-20 13:00:00 GMT"
}1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
js
const axios = require('axios');
const data = JSON.stringify({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemCanceled",
"order": "123456780000",
"item": "123456780001",
"cause": "CancelBookSize",
"message": "Book has wrong width",
"datetime": "2016-01-20 13:00:00 GMT"
}
);
const config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
headers: {
'Content-Type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error);
});1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.cloudprinter.com/cloudsignal/2.0/status/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemCanceled",
"order": "123456780000",
"item": "123456780001",
"cause": "CancelBookSize",
"message": "Book has wrong width",
"datetime": "2016-01-20 13:00:00 GMT"
}
',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
py
import requests
import json
url = "https://api.cloudprinter.com/cloudsignal/2.0/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemCanceled",
"order": "123456780000",
"item": "123456780001",
"cause": "CancelBookSize",
"message": "Book has wrong width",
"datetime": "2016-01-20 13:00:00 GMT"
}
)
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
sh
curl --location 'https://api.cloudprinter.com/cloudsignal/2.0/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemCanceled",
"order": "123456780000",
"item": "123456780001",
"cause": "CancelBookSize",
"message": "Book has wrong width",
"datetime": "2016-01-20 13:00:00 GMT"
}
'1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| apikey | string | api access key | required |
| type | string | valid value: ItemCanceled | required |
| order | string | the full order id | required |
| item | string | the full item id | required |
| cause | string | cause | optional |
| message | string | message | optional |
| delay | string | expected delay in hours | optional |
| datetime | string | timestamp | required |
| Code | Status | Description |
|---|---|---|
| 200 | OK | the request has succeeded |
| 400 | Bad request | the request was invalid or parameters are missing |
| 401 | Unauthorized | authentication failed |
| 403 | Forbidden | authentication failed |
Bundle signals
Multiple signals can be posted in a bundle. It is recommended only to bundle signals from a single order.
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"items": [
{
"type": "ItemRegistered",
"order": "123456780000",
"item": "123456780001",
"datetime": "2016-01-20 13:00:00 GMT"
},
{
"type": "ItemRegistered",
"order": "123456780000",
"item": "123456780002",
"datetime": "2016-01-20 13:00:00 GMT"
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Changes from v1.1 to v2.0
The following list describes the changes made from version 1.1 and 2.0 of the CloudSignal API. When updating from 1.1 to 2.0 please go through these changes.
- OrderRegistered has been removed and replaced with ItemRegistered.
- New CloudSignal API endpoints
- ItemShipped has a new required parameter
shipping_option