The choice of the service will only be available in the determined time interval described in general information about the service. |
Parameter
The change should be implemented in::
Creating a shipment in the simplified mode [1.9.0] Creating a shipment in the simplified mode
Shipment creation in offer mode [1.6.4] Creating and viewing shipment batches
Creating and viewing shipment batches [1.6.4] Creating and viewing shipment batches
Shipment edit [1.9.0] Shipment edit
In order to download the list of points available for the service, call the method for downloading machines with the parameter type=parcel_locker
_only e.g.: https://api-shipx-pl.easypack24.net/v1/points?type=parcel_locker_only then filter out machines that are not available 24/7 with the parameter location_247
set to true
(location_247": true
) or use https://api-shipx-pl.easypack24.net/v1/points?location_247=true.
Errors that may occur when creating a shipment:
|
curl --location 'https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1Ni...' \ --header 'Content-Type: application/json' \ --data-raw '{ "sender": { "name": "Name", "company_name": "Company_name", "first_name": "first_name", "last_name": "last_name", "email": "test@grupainteger.pl", "phone": "321321321", "address": { "street": "Czerniakowska", "building_number": "87A", "city": "Warszawa", "post_code": "00-718", "country_code": "PL" } }, "receiver": { "name": "Name", "company_name": "Company name", "first_name": "Jan", "last_name": "Kowalski", "email": "test@inpost.pl", "phone": "111222333" }, "parcels": { "template": "small" }, "insurance": { "amount": 25, "currency": "PLN" }, "cod": { "amount": 12.50, "currency": "PLN" }, "custom_attributes": { "sending_method": "dispatch_order", "target_point": "KRA012" }, "service": "inpost_locker_standard", "reference": "Test", "end_of_week_collection": true }' |
the Weekend delivery service can be searched by including the following filter parameter end_of_week_collection
, with either true or false values
if the parameter is set to true, i.e. end_of_week_collection=true
, only shipments with the Weekend Delivery option will be returned
in the absence of the filter parameter end_of_week_collection
, all shipments will be returned
Detailed information at [1.6.0] Shipment search and sorting
the web service object will be updated with the additional Weekend Delivery attribute
for the inpost_locker_standard service type the additional attribute will be returned with the following id: end_of_week_collection
Detailed information at [1.9.0] Shipment edit
when creating a shipment in the post method the parameter can be provided end_of_week_collection
with either true or false value,
the parameter is not required
in response, the price list will be returned, updated with the parameter end_of_week_collection_charge_amount
Detailed information at [1.7.0] Shipment price calculation
Response example:
[ { "id":"SHIPMENT1", "calculated_charge_amount":"27.20", "fuel_charge_amount":"0.00", "notification_charge_amount":"0.00", "cod_charge_amount":"0.00", "insurance_charge_amount":"20.00", "calculated_charge_amount_non_commission":"7.20", "end_of_week_collection_charge_amount":"4.99", }, { "id":"SHIPMENT2", "calculated_charge_amount":"18.00", "fuel_charge_amount":null, "notification_charge_amount":null, "cod_charge_amount":null, "insurance_charge_amount":null, "calculated_charge_amount_non_commission":null, "end_of_week_collection_charge_amount":"4.99" |