Creating and viewing shipment batches

Batch resource is used to create and view shipments in batches. In the asynchronous shipment processing, each shipment is processed separately, because of which webhooks will be sent for each shipment separately.

On this page

1 Structure
2 Authentication
3 Creating shipments in batches
4 Viewing batch shipments

Structure

Batch resource has the following attributes:

Attribute	Type	Description

Attribute	Type	Description
`id`	`Integer`	Batch ID
`status`	`String`	Batch status
`shipments`	`Array[Shipment`]	Shipment object array
`created_at`	`DateTime`	Batch creation date and time
`updated_at`	`DateTime`	Batch last update date and time

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"
}

Authentication

Access to the resource requires a valid access token.

Creating shipments in batches

Warning debit clients!

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

Parameter

Type

Description

Validation

only_choice_of_offer

Boolean

Setting the parameter to true results in the offer being selected for the given service but not being paid for. The shipment has to be paid for before the offer expiry. Paying for shipment

The attribute is optional.

Default false

shipments

Array[Hash]

The attribute is optional..

Minimum 1
Maximum 2500

Shipment parameters.

Parameter	Type	Description

Parameter	Type	Description
`id`	`String`	Required. Unique shipment ID within the batch that allows for validation errors to be returned in connection to a specific shipment. ID is not persisted in the database and is not returned as an attribute of an already created batch.
`...`	`...`	Other parameters are described in: Creating a shipment in the simplified mode

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

Error information

validation_failed - request parameters are incorrect.
forbidden - the user has insufficient permission for the given action
token_invalid - user token is invalid for the given organization

Viewing batch shipments