This section contains all of the API and webhook references for Skrym's booking-related functionality.

If you have any questions or need any help setting up, don't hesitate to reach out on .


Booking Multi-Parcel Shipments With Skrym

The booking.BookShipment API books the delivery of parcels with the specified transport method.
It works with the transporters' APIs as depicted in the diagram below:

The endpoint responds with 200 only if the booking has been successfully made with the transporter and we have acquired the labels.
If we cannot acquire the labels from the transporter, Skrym labels are generated instead.


{
  "bookingReference": "book-1",
  "wmsReference": "",
  "parcels": [
    {
      "reference": "book-1-parcel-1",
      "physicalProperties": {
        "weight": 1000,
        "length": 200,
        "height": 100,
        "width": 100
      }
    }
  ],
  "origin": {
    "countryCode": "SE",
    "postalCode": "17076",
    "city": "Solna",
    "address": "Rådjursstigen 22"
  },
  "destination": {
    "countryCode": "SE",
    "postalCode": "41111",
    "city": "Göteborg",
    "address": "Karin Boyes gata 7"
  },
  "receiver": {
    "name": "Test Person",
    "phone": "+41234567890",
    "email": "test.person@test.com",
    "address": {
      "countryCode": "SE",
      "postalCode": "41111",
      "city": "Göteborg",
      "address": "Karin Boyes gata 7"
    }
  },
  "addons": {},
  "transporter": "Postnord",
  "transportMethod": "Parcel",
  "workstation": {
    "reference": "",
    "currentUser": ""
  }
}


</CH.Code>

Endpoint Schema:

Once successfuly booked, you can trigger printing of the labels via .
In case of unsuccessful booking, you can call the endpoint again to re-try the booking.

There can be various reasons for a booking to fail, such as the transporter's API being down or the transporter not having the capacity to handle the shipment at that time.
Also, Skrym allows you to book shipments for multiple parcels using any of the transporter services available on its system. However, if the transporter does not support multi-parcel shipments, Skrym will book the shipment as multiple single-parcel shipments.
This can sometimes lead to partial bookings, where some parcels are successfully booked and others are not.
To address partially succesful or completely failed bookings, Skrym has introduced a new endpoint called RetryBooking. This endpoint allows you to book the all failed parcels that were not successfully booked in the initial booking.
Endpoint Schema:



Booking API

Printing Labels Through Skrym and PrintNode

Once you have succesful booked with Skrym, you can trigger the printing of the labels at any time.
At the moment, we only support printing via .


[
  {
    "printerId": "73381738",
    "bookingReferences": [
      "booking-1"
    ]
  },
  {
    "printerId": "73381740",
    "bookingReferences": [
      "booking-2"
    ]
  }
]



</CH.Code>

The printerId can be found on  or on your  account.
Endpoint Schema:

In case of unsuccessful printing, you can always call again with the failed bookingReferences to retry the printing process.

Print Labels With PrintNode API

Currently, we provide three separate webhooks that accessible through .
According to your WMS flow, you can trigger these webhooks as you would like.
On failure, these webhooks will update the order status in Ongoing accordingly.
Booking Only Webhook

Print Label Webhook

Book And Print Label Webhook
