CloudSignal API
This documentation describes the CloudSignal API v1.1
This version of the protocol has been depricated - Please upgrade to version 2.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 as 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
OrderRegistered: https://api.cloudprinter.com/1.1/status/
endpoint
https://api.cloudprinter.com/1.1/status/1
Order received and accepted by the production.
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "OrderRegistered",
"order": "123456780000",
"datetime": "2016-01-20 13:00:00 GMT"
}1
2
3
4
5
6
2
3
4
5
6
js
const axios = require('axios');
const data = JSON.stringify({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "OrderRegistered",
"order": "123456780000",
"datetime": "2016-01-20 13:00:00 GMT"
}
);
const config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.cloudprinter.com/cloudsignal/1.1/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
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
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.cloudprinter.com/cloudsignal/1.1/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": "OrderRegistered",
"order": "123456780000",
"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
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
py
import requests
import json
url = "https://api.cloudprinter.com/cloudsignal/1.1/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "OrderRegistered",
"order": "123456780000",
"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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
sh
curl --location 'https://api.cloudprinter.com/cloudsignal/1.1/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "OrderRegistered",
"order": "123456780000",
"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
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| apikey | string | api access key | required |
| type | string | valid value: OrderRegistered | required |
| order | string | the full order 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/1.1/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/1.1/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/1.1/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/1.1/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/1.1/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/1.1/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/1.1/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/1.1/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/1.1/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/1.1/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: https://api.cloudprinter.com/1.1/status/\
endpoint
https://api.cloudprinter.com/1.1/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/1.1/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/1.1/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/1.1/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/1.1/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/1.1/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",
"datetime": "2016-01-20 13:00:00 GMT"
}1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
js
const axios = require('axios');
const data = JSON.stringify({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemShipped",
"order": "123456780000",
"item": "123456780001",
"tracking": "1A2B3C4D5E6F",
"datetime": "2016-01-20 13:00:00 GMT"
}
);
const config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.cloudprinter.com/1.1/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
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
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.cloudprinter.com/1.1/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",
"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
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
py
import requests
import json
url = "https://api.cloudprinter.com/1.1/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemShipped",
"order": "123456780000",
"item": "123456780001",
"tracking": "1A2B3C4D5E6F",
"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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
sh
curl --location 'https://api.cloudprinter.com/1.1/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemShipped",
"order": "123456780000",
"item": "123456780001",
"tracking": "1A2B3C4D5E6F",
"datetime": "2016-01-20 13:00:00 GMT"
}
'1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
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 |
| 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/1.1/status/1
Item has problem or error. This could be due print error or failed in quality check etc.
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemError",
"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": "ItemError",
"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/1.1/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/1.1/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": "ItemError",
"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/1.1/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemError",
"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/1.1/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemError",
"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: ItemError | required |
| order | string | the full order id | required |
| item | string | the full item id | required |
| cause | string | text string explaning 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 |
ItemCanceled:
endpoint
https://api.cloudprinter.com/1.1/status/1
Item has been canceled.
Example request
json
{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemCanceled",
"order": "123456780000",
"item": "123456780001",
"cause": "190",
"message": "Example message",
"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": "190",
"message": "Example message",
"datetime": "2016-01-20 13:00:00 GMT"
}
);
const config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.cloudprinter.com/1.1/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/1.1/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": "190",
"message": "Example message",
"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/1.1/status/"
payload = json.dumps({
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemCanceled",
"order": "123456780000",
"item": "123456780001",
"cause": "190",
"message": "Example message",
"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/1.1/status/' \
--header 'Content-Type: application/json' \
--data '{
"apikey": "13b37bb1ed6d3403e158abe719b4f6d0",
"type": "ItemCanceled",
"order": "123456780000",
"item": "123456780001",
"cause": "190",
"message": "Example message",
"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 |