| Table of Contents |
|---|
...
...
Currently logistics operations are done from Monday to Friday. The purpose of the project is to launch a new additional parcel machine service that will guarantee delivery to an automatic parcel machine on Saturdays and Sundays.
...
...
...
◦ APIs will return the exception that the service is disabled
- automatic refund of the service charge:
◦ prepaid:
▪ automatic refund will be made if:
- the customer purchased the additional service in a particular week according to the calendar
- ordered courier delivery or delivered the parcel to the Point/Branch or placed in an automated parcel machine according to the terms and conditions
- the parcel has not been placed in an automated parcel machine on Saturday or on Sunday in the week when the additional service was purchased according to the terms and conditions.
◦ postpaid:
▪ the charge will not be included in the invoice if:
- the shipment will have not been forwarded
- the shipment will have not been placed in an automated parcel machine on Saturday or on Sunday in the week when the additional service was purchased according to the terms and conditions
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
A new parameter, called endOfWeekCollection, will be introduced:
...
...
...
<paczkomaty>
<pack>
...
...
...
...
...
...
...
<paczkomaty>
<pack>
...
...
...
...
...
<paczkomaty>
<pack>
...
...
...
...
Example of creating a shipment:
<paczkomaty>
<autoLabels>automatic_labels</autoLabels>
<selfSend>shipment_in_machine </selfSend>
<pack>
<id> temporary_pack_id</id>
<addresseeEmail>recipient_email_address</addresseeEmail>
<senderEmail>sender_email_address </senderEmail>
<phoneNum>recipient_phone_number </phoneNum>
<boxMachineName>parcel_machine_designation </boxMachineName>
<packType>pack_type </packType>
<endOfWeekCollection>true</endOfWeekCollection>
</pack>
</paczkomaty>
...
...
The Weekend Delivery service implementation in Shipx will include functionality described in the following sections.
3.1. Modifying the shipment object
- adding the following parameter to the shipment object: end_of_week_collection
- the parameter will be boolean and will accept true/false values
- true value will mean that the additional service is chosen
- the attribute is not required and it is false by default
- the choice of the service will only be available in the determined time interval described in general information about the service
- the exception format returned by API is in accordance with the current standard described in the documentation (https://docs.inpost24.com/pages/viewpage. action?pageId=983169#id- [1.3.0]APIInformacjeog%C3%B3lne-B%C5%82%C4%99dy)
◦ when selecting the additional service outside the indicated time interval, an exception will be returned by the application
▪ exception name (error): invalid_end_of_week_collection
◦ when selecting the Customer Service Point as the method of collecting the shipment an exception will be returned. Only parcel_locker_only type machines support Weekend Deliveries
▪ exception name (error): invalid_target_point_for_end_of_week_collection
- in order to download list of machines that does not contain Customer Service Points, the following method should be called along with the type=parcel_locker_only parameter e.g.: https://api-shipx- en.easypack24.net/v1/points?type=parcel_locker_only
◦ the service will not available for the Allegro shipments. An attempt to create an Allegro shipment with the Weekend Delivery service will result in an exception being returned by the application
▪ exception name (error): invalid_allegro_for_end_of_week_collection
- the change should be implemented in:
◦ creating a shipment in the simplified mode
(https://docs.inpost24.com/pages/viewpage.action?pageId=983195)
◦ creating shipments in the offer mode
(https://docs.inpost24.com/pages/viewpage.action?pageId=983167)
◦ creating multiple shipments
(https://docs.inpost24.com/pages/viewpage.action?pageId=983193)
◦ shipment details
◦ shipment updates
(https://docs.inpost24.com/pages/viewpage.action?pageId=983185)
Sample query for creating a shipment in the simplified mode:
POST /v1/organizations/123/shipments HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...
{
"receiver": {
"email": "receiver@example.com", "phone": "888000000"
},
"parcels": [
{
"template": "small"
}
],
"custom_attributes": { "target_point": "KRA010"
},
"insurance": { "amount": 25, "currency": "PLN"
},
"cod": {
"amount": 12.50, "currency": "PLN"
}, "end_of_week_collection":true "service": "inpost_locker_standard"
}
3.2. Shipment search modification
(https://docs.inpost24.com/pages/viewpage.action?pageId=983165)
- 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
3.3. Modifying services
(https://docs.inpost24.com/pages/viewpage.action?pageId=983176)
- 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 folloing id: end_of_week_collection
3.4. Modifying shipment price conversion
(https://docs.inpost24.com/pages/viewpage.action?pageId=983209)
- 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
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"
}
...