Warning! Resource is available only in the following countries: PL, IT |
ShipmentTemplate
resource object represents a serialized shipment template in the context of the organization that created it.
On this page
ShipmentTemplate
resource has the following attributes:
Attribute | Type | Description | Accepted values | Availability |
---|---|---|---|---|
| String | Template name | PL, IT | |
| String | Status |
| PL, IT |
| String | Template description | PL, IT | |
| JSON | Serialized | PL, IT | |
| DateTime | Last template update date and time. | PL, IT | |
| DateTime | Template creation date and time. | PL, IT |
ShipmentTemplate
resource example JSON format:
{ "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 within the given organization:
GET /v1/organizations/:organization_id/shipment_templates |
Request example
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/shipment_templates -H "Authorization: Bearer token" -H "Content-Type: application/json" |
Response
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:
|
Retrieving template information to which the user has access to
GET /v1/shipment_templates/:id |
Request example
curl -X GET https://api-shipx-pl.easypack24.net/v1/shipment_templates/1 -H "Authorization: Bearer token" -H "Content-Type: application/json" |
Response
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:
|
Creating a new template
POST /v1/organizations/:organization_id/shipment_templates |
Parameters
Parameter | Type | Description | Validation | Availability |
---|---|---|---|---|
| String | Template name | Required parameter.
| PL, IT |
| String | Template status | Required parameter.
| PL, IT |
| String | Template description | Required parameter.
| PL, IT |
| Shipment | serialized Shipment object | Required parameter. | PL, IT |
Request example
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
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
|
Edition of an existing template
PUT /v1/shipment_templates/:id |
Parameters
Parameter | Type | Description | Validation | Availability |
---|---|---|---|---|
| String | Template Name | Optional parameter.
| PL, IT |
| String | Template status | Optional parameter.
| PL, IT |
| String | Template description | Optional parameter.
| PL, IT |
| Shipment | serialized Shipment object | Optional parameter. | PL, IT |
Request example
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
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
|
Deleting an existing template.
DELETE /v1/shipment_templates/:id |
Request example
curl -X DELETE https://api-shipx-pl.easypack24.net/v1/shipment_templates/1 -H "Authorization: Bearer token" -H "Content-Type: application/json" |
Response
HTTP/1.1 204 NO_CONTENT Content-Type: application/json |
Error information
|