Custom rate

Introduction

As explained in Rate, rates and rating play a key part in the shipping process. Wuunder is there to take care of it. For booking shipments without Wuunder choosing the rates, a custom rate can be send along with a shipment.

This is only available on the Book order endpoint.

On the payload for rate_selections a rate object can be set per element, next to the shipment_id. In order for this to be accepted, please contact support to ensure that the configuration is configured correctly.

Wuunder configures the connection to carriers, including credentials and carrier specific setup to book accordingly. To take advantage of this configuration, a custom rate can be set that matches in Wuunder on the carrier and product codes. When choosing to bypass the Wuunder configuration, you need to add credentials and carrier specific settings along with the request which requires some knowledge of Wuunders systems, please contact support about how to tackle this as this requires a case by case approach.

Using Wuunders configuration

When using Wuunders configuration you will need to send the following information at least:

• carrier_code: The code fo the carrier that will ship the package. E.g. POST_NL, DPD, ASENDIA. This needs to be uppercased and requires matching to codes that Wuunder uses.
• carrier_product_code: The product code that is matched to specific products within Wuunder. E.g. POSTNL_NON_EU_B2C, POSTNL_DROP_AT_PARCELSHOP_GEGARANDEERD_10_UUR.
• delivery_date: The expected date of delivery in ISO-8601. E.g. 2025-01-02
• pickup_date: The date of pickup in ISO-8601. E.g. 2025-01-01

The carrier_code and carrier_product_code are the fields that are used to find the correct configuration. This is matched to what your account is accessed to use and will return an error when you cannot access the expected product.

The dates can be shared with the carrier regarding pickups and sometimes for expected deliveries, but differs per carrier.

Other fields can be set but function more as a supporting role. These have defaults as well.

• delivery_after: The start of the delivery timeframe. (defaults to "09:00:00")
• delivery_before: The end of the delivery timeframe. (defaults to "18:00:00")
• is_return: Flag to indicate if the shipment is a return shipment. (defaults to false)
• is_parcelshop_drop_off: Flag to indicate if the shipment will be dropped off at a parcelshop instead of picked up. (defaults to false)
• labelless: Flag to indicate if the product needs to be labelless. (defaults to false)
• price: The price of the service the customer pays used in cents. (defaults to 0)
• purchase_price: The price of the service you pay used in cents. (defaults to 0)
• product: A specialized key to set the service for a specific type of shipment. E.g. 3805 for a Standard PostNL shipment.
• tracking: Flag to indicate if the rate can be tracked by Wuunder for status updates. (defaults to true)
• pickup_after: The start of the pickup timeframe. (defaults to "09:00:00")
• pickup_before: The end of the pickup timeframe. (defaults to "18:00:00")

These properties can be used to improve the carrier communication and ensure the expected label is booked.

An example payload for to use the configuration with the book order endpoint:

{
  "book_order": {
    "rate_selections": [
      {
        "shipment_id": "57168dba-c987-4755-9c3b-6c5d86825e75",
        "rate": {
          "carrier_code": "POST_NL",
          "carrier_product_code": "POSTNL_NON_EU_B2C",
          "delivery_date": "2025-01-02",
          "pickup_date": "2025-01-01",
          "product": "3085",
          "price": 395,
          "purchase_price": 390,
          "pickup_after": "15:00:00",
          "pickup_before": "17:00:00"
        }
      }
    ]
  }
}

Fully customized