[1.2.0] Shipment templates
ShipmentTemplate resource object represents a serialized shipment template in the context of the organization that created it.
On this page
Structure
ShipmentTemplate resource has the following attributes:
| String | Template name |
|
| String | Status |
|
| String | Template description |
|
| JSON | Serialized |
|
| DateTime | Last template update date and time. |
|
| DateTime | Template creation date and time. |
|
ShipmentTemplate resource example JSON format:
1
2
3
4
5
6
7
8
9
10
11
{
"href": "https://api-shipx-pl.easypack24.net/v1/shipment_templates/1",
"id": 1,
"organization_id": "1",
"status": "activated",
"description": "description...",
"serialized_data": {...},
"organization": { ... },
"updated_at": "2015-09-29T15:22:00.000+02:00",
"created_at": "2015-09-29T15:22:00.000+02:00"
}
Template List
Template list within the given organization:
1
GET /v1/organizations/:organization_id/shipment_templatesRequest example
1
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/shipment_templates -H "Authorization: Bearer token" -H "Content-Type: application/json"Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
HTTP/1.1 200 OK
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipment_templates",
"count": 15,
"per_page": 30,
"page": 1,
"items": [
{
"href": "https://api-shipx-pl.easypack24.net/v1/shipment_templates/1",
"id": 1, "organization_id": "1",
"status": "activated",
"description": "description...",
"serialized_data": {...},
"organization": { ... },
"updated_at": "2015-09-29T15:22:00.000+02:00",
"created_at": "2015-09-29T15:22:00.000+02:00"
}
]
}
Error information
The response can contain the following errors:
resource_not_found- organization for which the user wants to retrieve the template list doesn't exist or the user has no access to it.
Template details
Retrieving template information to which the user has access to
1
GET /v1/shipment_templates/:idRequest example
1
curl -X GET https://api-shipx-pl.easypack24.net/v1/shipment_templates/1 -H "Authorization: Bearer token" -H "Content-Type: application/json"Response
1
2
3
4
5
6
7
8
9
10
11
12
13
HTTP/1.1 200 OK
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/shipment_templates/1",
"id": 1,
"status": "activated",
"description": "(API Tests)",
"name": "Inittec Sp. z o.o. ",
"serialized_data": { ... },
"organization": { ... },
"created_at": "2016-03-22T09:31:28.609+01:00",
"updated_at": "2016-03-22T09:31:28.609+01:00"
}
Error information
The response can contain the following errors:
resource_not_found- template doesn't exist or the user has no access to it.
Template Creation
Creating a new template
1
POST /v1/organizations/:organization_id/shipment_templatesParameters
| String | Template name | Required parameter.
|
| String | Template status | Required parameter.
|
| String | Template description | Required parameter.
|
| Shipment | serialized Shipment object | Required parameter. |
Request example
1
2
3
4
5
6
7
8
9
10
11
12
13
POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipment_templates
{
"name":"template name",
"status":"suspended",
"description":"description...",
"serialized_data": {
"receiver": {
"email": "paczkomat@test.pl",
"phone": "888000022"
},
"parcels": { "template": "small"}
}
}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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
HTTP/1.1 200 OK
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/shipment_templates/6",
"id": 6,
"name": "non-active",
"status": "suspended",
"description": "description...",
"organization": {
...
},
"template": {
"status": "created",
"service": null,
"custom_attributes": {},
"cod": {
"amount": null,
"currency": null
},
"insurance": {
"amount": null,
"currency": null
},
"additional_services": [],
"reference": null,
"is_return": false,
"parcels": [
{
"id": null,
"template": "small",
"dimensions": {
"length": 380,
"width": 640,
"height": 80,
"unit": "mm"
},
"weight": {
"amount": 25,
"unit": "kg"
},
"tracking_number": null
}
],
"sender": null,
"receiver": {
"id": null,
"name": null,
"company_name": null,
"first_name": null,
"last_name": null,
"email": "paczkomat@test.pl",
"phone": "888000022",
"address": null
}
},
"created_at": "2016-10-04T12:43:37.454+02:00",
"updated_at": "2016-10-04T12:43:37.454+02:00"
}
Error information
validation_failed- request data is invalid. Details are available in thedetailsfield,resource_not_found- organization doesn't exist or the user has no access to it.
Template Editing
Edition of an existing template
1
PUT /v1/shipment_templates/:idParameters
| String | Template Name | Optional parameter.
|
| String | Template status | Optional parameter.
|
| String | Template description | Optional parameter.
|
| Shipment | serialized Shipment object | Optional parameter. |
Request example
1
2
3
4
5
6
curl -X PUT https://api-shipx-pl.easypack24.net/v1/shipment_templates/1 -H "Authorization: Bearer token" -H "Content-Type: application/json" -d '{
"name":"szablon_1",
"status":"activated",
"description":"description...",
"serialized_data": { ... }
}' Response
1
2
3
4
5
6
7
8
9
10
11
12
13
HTTP/1.1 200 OK
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/shipment_templates/1",
"id": 1,
"status": "activated",
"description": "(API Tests)",
"name": "Inittec Sp. z o.o. ",
"serialized_data": { ... },
"organization": { ... },
"created_at": "2016-03-22T09:31:28.609+01:00",
"updated_at": "2016-03-22T09:31:28.609+01:00"
}
Error information
validation_failed- request data is invalid. Details are available in thedetailsfield,resource_not_found- template doesn't exist or the user has no access to it.
Template Deletion
Deleting an existing template.
1
DELETE /v1/shipment_templates/:idRequest example
1
curl -X DELETE https://api-shipx-pl.easypack24.net/v1/shipment_templates/1 -H "Authorization: Bearer token" -H "Content-Type: application/json"Response
1
2
HTTP/1.1 204 NO_CONTENT
Content-Type: application/json
Error information
resource_not_found- template doesn't exist or the user has no access to it.