<aside> <img src="/icons/forward_gray.svg" alt="/icons/forward_gray.svg" width="40px" /> $\colorbox{19abff}{\color{ffffff}{POST}}$ PROD: https://api.helthjem.no/parcels/v1/bookings PRE-PROD: https://api.pre.helthjem.no/parcels/v1/bookings

</aside>

The purpose of this API is to register a parcel shipment from a consignor (could be a private person or a shop) to a consignee ( private person or a shop).

You can use request examples below directly in your setup just by changing  tranportSolutionId and ShopId

Coverage

Depending on the transportSolutionId you send in the request and address coverage, you will get either:

To avoid getting "no.carrier.support” when booking please make sure you always do the coverage check with Single Address Check API before sending the booking request.

<aside> 📘 Detailed documentation https://jira-di.atlassian.net/wiki/spaces/DIPUB/pages/68026370/Parcel+Booking+API

</aside>

Example 1: booking with transportSolutionId:"1"

With transportSolutionId:"1", we have coverage throughout Norway. The response will include one of the following options, depending on selected address:

Request example 1

{
    "shopId": 1,
    **"transportSolutionId": 1,**
    "shipmentId": "",
    "parties": [
        {
            "type": "consignee",
            "name": "Test Customer",
            "countryCode": "NO",
            "postalName": "Oslo",
            "zipCode": "0566",
            "address": "Fjellgata 48",
            "phone1": "53582094",
            "email": "[email protected]",
            "reference": "cust_ref",
            "contact": "contact2"
        },
        {
            "type": "consignor",
            "name": "Test shop",
            "countryCode": "NO",
            "postalName": "Oslo",
            "zipCode": "0480",
            "address": "Sandakerveien 121",
            "phone1": "",
            "contact": "contact1",
            "reference": "shop_ref",
            "email":""
        }
    ],
    "items": [
        {
            "itemNumber": 1,
            "trackingReference": "",
            "weight": 1000,
            "width": 12,
            "height": 12,
            "length": 12,
            "contents": "test item"
        }
    ]
}

Response example 1

{
    "shipmentId": "(401)70724762337121945",
    "freightProductId": 1,
    "parties": [
        {
            "type": "consignee",
            "id": null,
            "name": "Test Customer",
            "countryCode": "NO",
            "postalName": "Oslo",
            "zipCode": "0566",
            "address": "Fjellgata 48",
            "phone1": "53582094",
            "phone2": null,
            "email": "[email protected]",
            "reference": "cust_ref",
            "contact": "contact2",
            "coaddress": null
        },
        {
            "type": "consignor",
            "id": null,
            "name": "Test shop",
            "countryCode": "NO",
            "postalName": "Oslo",
            "zipCode": "0480",
            "address": "Sandakerveien 121",
            "phone1": "",
            "phone2": null,
            "email": "",
            "reference": "shop_ref",
            "contact": "contact1",
            "coaddress": null
        }
    ],
    "items": [
        {
            "itemNumber": 1,
            "trackingReference": "(00)370724762337121953",
            "returnCode": null,
            "linkedParcelType": null,
            "linkedTrackingReference": null,
            "weight": 1000,
            "volume": null,
            "length": 12.0,
            "height": 12.0,
            "width": 12.0,
            "contentValue": null,
            "externalSupplierId": null,
            "contents": "test item",
            "properties": {
                "shortItemIdentifier": "...1953"
            },
            "articles": [],
            "externalOrderId": null
        }
    ],
    "properties": {
        "areaId": "59",
        "freightProductName": "helthjem",
        "mainCarNumber": "14",
        "pickupZipString": "0556 OSLO",
        "productName": "helthjem standard",
        "regionId": "189",
        "routeAddress": "TOFTES GATE 21 B",
        "routeDescription": "BUDSENTRAL RINGNES PARK",
        "routeName": "22140",
        "routeSeq": "121",
        "routeZipAndCity": null,
        "routing": "14-0-x22140x121",
        "routingCode": "1",
        "routingDescription": "RINGNES PARK",
        "routingDetailed": "14 - RINGNES PARK",
        "shopName": "Testbutikken",
        "transportCompanyId": "1",
        "transportNetId": "223"
    },
    "additionalServices": [],
    "orderId": 89828037
}

Example 2: booking delivery to a service point