Structure
Batch
resource has the following attributes:
Attribute | Type | Description | Availability |
---|---|---|---|
id | Integer | Batch ID | PL, IT |
status | String | Batch status | PL, IT |
shipments | Array[Shipment ] | Shipment object array | PL, IT |
created_at | DateTime | Batch creation date and time | PL, IT |
updated_at | DateTime | Batch last update date and time | PL, IT |
Batch
resource in JSON format:
{ "href": "https://api-shipx-pl.easypack24.net/v1/batches/16", "id": 16, "status": "done", "shipments": [ { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/151", "id": 151, "status": "confirmed", "tracking_number": "633100159730624319900067" }, { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/150", "id": 150, "status": "confirmed", "tracking_number": "633100159730624319900068" } ], "created_at": "2017-06-08T14:17:25.675+02:00", "updated_at": "2017-06-08T14:17:25.675+02:00" }
Creating shipments in batches
Uwaga! Klienci debetowi
After creating a shipment we do not return prices for debit clients. The rate
attribute is null
POST /v1/organizations/:organization_id/batches
Parameters
Parameter | Type | Description | Validation | Availability | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
only_choice_of_offer | Boolean | Setting the parameter to | The attribute is optional.
| PL, IT | |||||||||
shipments | Array[Hash] |
| The attribute is optional..
| PL, IT |
Example request
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/batches -H 'Authorization: Bearer token' -H 'content-type: application/json' -d '{ "only_choice_of_offer": false, "shipments": [ { "id": 1, "service": "inpost_locker_standard", "custom_attributes": { "target_point": "KRA010" }, "parcels":{ "template": "small" }, "receiver": { "company_name": "Company name 1", "email": "sklep@inpost.pl", "phone": "888888888", "address": { "line1": "Zawila 65L", "city": "Krakow", "post_code": "30-390", "country_code": "PL" } }, "sender": { "company_name": "Company name 2", "email": "sklep@inpost.pl", "phone": "999999999", "address": { "line1": "Zawila 65L", "city": "Krakow", "post_code": "30-390", "country_code": "PL" } }, "cod": { "amount": 1, "currency": "PLN" }, "insurance": { "amount": 23, "currency": "PLN" } }, { "id": 2, "service": "inpost_locker_standard", "custom_attributes": { "target_point": "KRA010" }, "parcels":{ "template": "small" }, "receiver": { "company_name": "Company name 1", "email": "sklep@inpost.pl", "phone": "888888888", "address": { "line1": "Zawila 65L", "city": "Krakow", "post_code": "30-390", "country_code": "PL" } }, "sender": { "company_name": "Company name 2", "email": "sklep@inpost.pl", "phone": "999999999", "address": { "line1": "Zawila 65L", "city": "Krakow", "post_code": "30-390", "country_code": "PL" } }, "cod": { "amount": 1, "currency": "PLN" }, "insurance": { "amount": 23, "currency": "PLN" } } ] }'
Response
HTTP/1.1 201 Created Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/batches/35", "id": 35, "status": "in_progress", "shipments": [ { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/195", "id": 195, "status": "confirmed", "tracking_number": "520000017830390003337439" }, { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/195", "id": 195, "status": "offer_selected", "tracking_number": "520000017830390003337439" }, { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/196", "id": 196, "status": "create", "tracking_number": null } ], "created_at": "2017-06-12T14:19:20.432+02:00", "updated_at": "2017-06-12T14:19:20.432+02:00" }
Error information
validation_failed
- request parameters are incorrect.forbidden
- the user has insufficient permission for the given actiontoken_invalid
- user token is invalid for the given organisation
Viewing batch shipments
GET /v1/batches/:id
Example request
curl -X GET https://api-shipx-pl.easypack24.net/v1/batches/16 -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/batches/16", "id": 16, "status": "done", "shipments": [ { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/151", "id": 151, "status": "confirmed", "tracking_number": "633100159730624319900067" }, { "href": "https://api-shipx-pl.easypack24.net/v1/shipments/150", "id": 150, "status": "confirmed", "tracking_number": "633100159730624319900068" } ], "created_at": "2017-06-08T14:17:25.675+02:00", "updated_at": "2017-06-08T14:17:25.675+02:00" }
Error information
resource_not_found
- The batch doesn't exist.token_invalid
- The user token is invalid or the user has no access to the given batch