API updates
You can also subscribe to our RSS feed.
Common APIs
Event Cast API - Subscription on customer numbers
Starting June 19, 2024, the Event Cast API will support subscriptions on customer numbers. This new feature complements the existing functionality to subscribe on shipment or parcel numbers and does not replace them.
With customer number subscriptions, you’ll automatically receive updates for all shipments registered on that customer number, removing the need to manage individual subscriptions for each new shipment or parcel. These subscriptions will have a validity of one year.
To start using the new customer number subscription, please see to the updated Event Cast API documentation.
Shipping Guide API - Service text updates
In the coming weeks, we will be enhancing the service texts within the Shipping Guide API.
These updates relates to how the delivery options are described in checkout. The texts are updated with the latest information about each delivery option, and will be available in Norwegian, Swedish, Danish, and English.
We will update the text for the dynamic fields: displayName
, descriptionText
, helpText
, and shortName
. If you currently use these fields, no action is required. The structure and fields will remain unchanged; only the dynamic text will be updated.
For those not currently using these fields, we recommend utilize them to optimize your checkout. In the API, text related to delivery option will reflect the latest changes and ensuring that your customers receive accurate information about each delivery option.
Reports API - Rate limiting API requests for creating reports
Starting from 17 June 2024, requests for creating reports will be rate limited. This is to ensure that our services remain stable. You can see more details under the “Rate limiting” section in the Reports API documentation.
Tracking API - Deprecation of Unauthenticated requests
Starting from May 13th, unauthenticated requests will no longer have access to the Tracking API. Previously, we implemented rate limiting measures. Read here on how to make authenticated requests.
If you see following error message that means you are not sending authenticated requests.
401 - Unathorized. The Tracking API no longer supports unauthenticated requests. Make sure your requests are authenticated. Read more about this on our Bring developer site. https://developer.bring.com/api/tracking/
Booking API - Deprecation of SOAP endpoint
The SOAP endpoint is now deprecated. Going forward the API will only support application/json
and application/xml
as Content-Type.
If you are currently relying on the SOAP endpoint of Booking API, you have until 1 October 2024 to migrate to the JSON/XML over HTTP based endpoints.
We will start rate limiting requests to the SOAP endpoint from 1 September 2024, with gradually reduced request rate until 1 October. This means that you will risk rejected requests because of rate limiting after 1 September
Older updates
Shipping Guide API - Deprecation of SOAP endpoint
The SOAP endpoint is now deprecated. Going forward the API will only support application/json
and application/xml
as Content-Type.
If you are currently relying on the SOAP endpoint of Shippingguide API, you have until 1 October 2024 to migrate to the JSON/XML over HTTP based endpoints.
We will start rate limiting requests to the SOAP endpoint from 1 September 2024, with gradually reduced request rate until 1 October. This means that you will risk rejected requests because of rate limiting after 1 September
Tracking API – Starting from 2nd of May, 2024, we will reject browser calls associated with a customer number to enhance security.
We have discovered some API users exposing username and API key openly in the source code of their website. This means that this information is accessible to anyone with a certain level of technical expertise. This poses a security risk as it allows unauthorized access to information about agreements with Posten Bring, as well as GDPR-sensitive customer data.
To address this, we strongly recommend that you call our Tracking API from the backend instead of via the browser. This way, this information will not be exposed. We advise you to promptly delete the current API key and generate a new one here: https://www.mybring.com/useradmin/account/settings/api
If it is not feasible to call our APIs from the backend and you are entirely dependent on doing so via the browser, we recommend creating a new user account not associated with your customer numbers. You can create such an account here: https://www.mybring.com/useradmin/account/settings/api
Please note that starting from May 2, 2024, we will reject browser calls associated with a customer number to enhance security.
Booking API - Changes in weight limit for Pickup Parcel (0340) and Pickup Parcel Bulk (0342) to Denmark
On February 29th 2024, we are adjusting the weight limit for bookings of Pickup Parcel (0340) and Pickup Parcel Bulk (0342) to Denmark in the Booking API.
What is changing?
Starting from February 29th, all bookings exceeding 20 kg (i.e. where the “weightInKg” field exceeds 20) for Pickup Parcel (0340) and Pickup Parcel Bulk (0342) will be rejected by the Booking API. Despite not being in line with our current terms stating a max weight of 20 kg, these bookings have been accepted in our API and later converted to Home Delivery Parcel 0349 with a special handling fee of 125 DKK. The new max weight of 20 kg aims to increase end customer satisfaction by minimizing the number of bookings that must be converted from Pickup Parcel (0340/0342) to Home Delivery Parcel (0349).
What should you do?
No need to worry! If you need to book parcels weighing over 20 kg, use Home Delivery Parcel (0349), which allows you to send parcels up to 35 kg. If for some reason there is a difference between the weight provided via the Booking API and the weight measured when the parcel reaches our terminal, we will still append a special handling fee and convert to Home Delivery Parcel (0349).
What if I have any questions?
You’re more than welcome to reach out to us via checkoutdk@bring.com. We’re here to assist in case you have any questions about the change, our APIs in general, or how to make the most of Bring in your checkout process.
Booking API - Changes in Pickup Order API format
On January 10, 2024, we are changing the API request format for pickupDetails in the Pickup Order request.
The new Pickup Order request format uses the package
, pallet
and postContainer
field to give information on packages, pallets and postContainers.
Each of these has a count
field, weightInGrams
field and volumeInDm3
field.
See Order a pickup for request examples in json/xml.
This enables weight and volume to be given on each goods item level, instead of as a total.
Reports API - Delaying date of removal of REST endpoint
The removal of the following API endpoints:
- /reports/api/invoices/{customerOrGroupId}
- /reports/api/invoices/{customerOrGroupId}.json
- /reports/api/invoices/{customerOrGroupId}.xml
will be delayed to 1. September 2023.
the replacement API is documented here
Reports API - Removal of REST endpoint
The following API endpoints will be removed from the Reports application after June 2023:
- /reports/api/invoices/{customerOrGroupId}
- /reports/api/invoices/{customerOrGroupId}.json
- /reports/api/invoices/{customerOrGroupId}.xml
the replacement API is documented here
Booking API - Deprecation of SOAP endpoint
The SOAP endpoint is now deprecated. Going forward the API will only support application/json
and application/xml
as Content-Type.
If you are currently relying on the SOAP endpoint of Booking API, you have until 1 March 2024 to migrate to the JSON/XML over HTTP based endpoints.
We will start rate limiting requests to the SOAP endpoint from 1 February 2024, with gradually reduced request rate until 1 March. This means that you will risk rejected requests because of rate limiting after 1 February
Shipping Guide API - Deprecation of SOAP endpoint
The SOAP endpoint is now deprecated. Going forward the API will only support application/json
and application/xml
as Content-Type.
If you are currently relying on the SOAP endpoint of Shipping Guide API, you have until 1 March 2024 to migrate to the JSON/XML over HTTP based endpoints.
We will start rate limiting requests to the SOAP endpoint from 1 February 2024, with gradually reduced request rate until 1 March. This means that you will risk rejected requests because of rate limiting after 1 February
Deprecation of Unauthenticated Open Tracking API
Our customers are increasingly demanding new functionality and solutions that are easy to use. To meet these expectations, we must know which customers and partners are using our APIs and how they are using them. To further develop the value proposition of our Tracking API, the solution will require authentication. Read here on how to make authenticated requests.
From 15 August 2023, we will start rate liming the requests.
If you see following error message that means you are being rate limited, and you should start using authenticated requests.
429 - Too many requests. We are now rate limiting our unauthenticated users, to prevent this make sure your requests are authenticated. Read more about this on our Bring developer site. https://developer.bring.com/api/tracking/
ShippingGuide API
Going forward Shippinguide API will support leadtime, prices, servicetext for service 5300 & 5400 to and from svalbard.
More details can be found here Svabard Shipments
ShippingGuide API
Going forward Shippinguide API will support leadtime, prices, servicetext for service 5100 to and from svalbard.
More details can be found here Svabard Shipments
Booking API - Required recipient mobile number for delivery to locker
Starting 30 March 2023, validation of the recipient mobile number for delivery to locker in SE, DK, and FI is being introduced. API requests for delivery to specific pickup point id of the locker type without providing a valid recipient mobile number, will not be accepted.
More details on how Optional Pickup Point can be ordered is found here: API service portfolio – Bring Developer
ShippingGuide API
Going forward Leadtimes will vary depending on whether you have a pickup agreement with Bring.
More details on how pickup agreement affects your leadtime can be found here Leadtime
Booking API - Validation of Dangerous Goods information
Starting 15 March 2023, a new version of the Norwegian cargo waybill with a separate Dangerous Goods Specification page incl. calculated ADR points is launched. API requests for dangerous goods service with the invalid unNumber and/or null weightInGrams/volumeInLitres will not be accepted.
More details on how dangerous goods information should be sent is found here API service portfolio – Bring Developer
Pickup Point API - Correction for new pickup point type in Sweden
Yesterday a new pickup point type for Sweden was launched (type “39”), but it was incorrectly named as “iBoxen paketbox”. The correct name is “Bring paketbox”, while the name “iBoxen paketbox” refers to the existing type “38”.
Sorry about the confusion.
Pickup Point API - New pickup point type in Sweden
A new pickup point type “39” (iBoxen paketbox) is now supported for Sweden
New postal code API
A new postal code API is now available. The postal code API hosted under /pickuppoint/api/postalCode has been deprecated.
Note! Removal of temporary domain api-new.bring.com
From 19 January 2023, APIs hosted on api-new.bring.com will stop working. Please start using api.bring.com instead of api-new.bring.com.
For more queries contact to integrasjon.norge@bring.com (Norway) or edi@bring.com (outside Norway).
Shipping Guide and Booking APIs
Starting 1 February 2023, minimum shipment weight for 5300 Partigods til bedrift (Partload) will be set to 3500 kg. API requests for 5300 service with a lower total shipment weight will not be accepted.
Shipping Guide and Booking APIs
Starting 1 February 2023, minimum shipment weight for 5300 Partigods til bedrift (Partload) will be set to 3500 kg. API requests for 5300 service with a lower total shipment weight will not be accepted.
Booking API (Pickup Order)
Starting 1 February 2023, maximum weight for a pickup order for cargo shipments in Norway will be set to 9999 kg chargeable weight. This limit corresponds to the existing chargeable weight limit for a groupage shipment. Shipments above 9999kg are handled as a door-to-door direct transport service (partload) and, hence, are not eligible for the pickup order service.
Address API
A new address suggestion API is available. The API provides address suggestions matching the provided query string, including house numbers and letters. There are now 2 suggestion APIs available:
- Street or place suggestions (existing)
- Address suggestions (new)
More details here
Booking API
For services 4850 and 5000, pickup point type 37 (locker/pakkeboks) cannot be requested.
ShippingGuide API
The Same day delivery VAS (2012) allows shipments to be delivered same or next-day, depending on when the shipment is booked. By default, SG API returns the full service coverage area for Same day delivery.
The “sortingAreas” tag allows the web shop to reduce the delivery area to the area they currently choose to provide the service.
The “routeInformation” tag ontains information about the sorting area for a specific parcel. Intended use is to aid pre-sorting of same day parcels.
For more information read https://developer.bring.com/api/shipping-guide_2/#sorting-area-for-same-day-delivery-2012
PickupPoint API
Pakkeboks pickup points (unit type: 37) in Norway now shows photos of the location. This can be used to assist the end user to find the placement of the pakkeboks at the address.
Booking API
Important: We’ll soon stop supporting API access on the https://www.mybring.com/booking/api
base URL.
Please use https://api.bring.com/booking/api
instead, if you aren’t already.
Shipping Guide API
Lead time does not only depend on the recipient’s postal code, but also the address itself.
For example, two different addresses on the same postal code can have different lead time. We have therefore added an addressLine field, which allows lead time to be calculated based on both postal code and street address. For this to work, it is important that recipients fill out a valid street address.
By using our Address API, the address the recipients fill inn can be pre-validated, which will ensure more accurate lead times.We therefore recommend using the Address API in combination with Shipping Guide API.
There are several services that are affected by this new field: 1000, 1988, 3500, 5000, 1736, 5600, 0330, 0332, 0349, 3570, 3584
<ns:AddressLine>Testsvingen 12</ns:AddressLine>
"addressLine":"Testsvingen 12"
Tracking API
The event statuses ARRIVED_COLLECTION and ARRIVED_DELIVERY are not valid anymore, and therefore have been removed from the Tracking API.
Tracking API
Starting 1 August 2022, Tracking API version v1 will be deprecated and the requests will be automatically forwarded to the latest version, v2. It is not a breaking change. In the new version you will have access to many more fields.
Shipping Guide API
For customers requesting environmental data in Shipping Guide API, a link to an environmental logo that can be used in checkout is now being returned in the guiInformation
part of the response. Note that the WithGuiInformation
field must therefore be set to true. The environmental data description text has also been extended to cover 5800 Pakke til hentested and 0340 Pickup Parcel/0342 Pickup Parcel Bulk when sent to Norway.
Reports API
PIP services are now visible in Mybring Delivery quality
report for Parcel Norway domestic.
Reports API
New report Complete status including freight cost
for Parcel Norway domestic added to Mybring.
Invoice and Reports API
Invoice and reports API will use main customer number to get invoice and reports data for parcel international customers.
Address API
Address API now supports post office box address queries and validation
Postal code and Shipping guide APIs
Country code SJ (Svalbard and Jan Mayen) has been added to the list of supported country codes
Tracking API
As an increased security measure, we have hidden the pickup code from the open Tracking API. The logged in Tracking API will still contain the pickup code.
ShippingGuide API
Courier bicycle services are currently not supported in Norway.
Booking API
The tracking link in the response from booking API is changed from http to https.
Shipping Guide API
For estimated arrival times for Norwegian parcels going to pickup points, it is now possible to get arrival date specific arrival times at pickup point when
requesting alternate delivery days. The number of expected working days is also returned. For arrival times at pickup points, the ExpectedDelivery
response
element normally used for lead time information is not returned. In stead a list of EstimatedDeliveryTimes
is available.
Read more about estimated arrival times here
Upcoming DNS change 1st of April 2022
Bring’s applications and infrastructure are going through bigger changes, as part
of modernizing our infrastructure. One of these changes, is update of our
load balancing component, and that will affect services running on api.bring.com
.
Be sure to verify your integration before the change to ensure no service disruption.
Tracking API
The Tracking API now includes the details of the expected pickup point, where an item is expected to arrive. It contains expected pickup-point-unit id, name and URL(a link to detailed information of pickup point like location, opening hours, etc).
Shipping Guide API
Environmental data including electric and fossil free transportation used during last mile transport leg, is now available for selected Norwegian domestic and Nordic parcel services.
ShippingGuide API
Posten/Bring logo URL is now returned when WithGuiInformation is requested.
Booking API
When booking parcel services from Finland, weight and dimensions are mandatory to set in the request.
PickupPoint API
Driving time to returned pickup points is now available in response
ShippingGuide API
Total number of zones used as basis for returned price, is now available for revised groupage and Norwegian domestic parcel services
ShippingGuide API
When requesting 5600 or PÅ_DOREN, the requested shipping date cannot be more than 10 days away if alternate delivery days are requested (via numberOfAlternativeDeliveryDates)
Booking API
It is now possible to book Nordic parcels with Limited Quantities (0003) additional service
Booking API
When booking BUSINESS_PARCEL or PICKUP_PARCEL export from Norway, it is now possible to pass an IOSS number as an iossNumber element.
Postal Code API
Icelandic postal codes are now supported
Shipping guide API
The Shipping guide API now includes estimated arrival time window of delivery for selected domestic Norway cargo services.
Booking API
When booking BUSINESS_PARCEL or PICKUP_PARCEL export from Norway, the customs declaration field CountryOfOrigin is now mandatory. In addition, the recipient email address or phone number has to be provided.
Postal Code API
Exposed two new endpoints for listing all available postal codes for supported countries.
Shipping Guide API
Version 1.0 was decommissioned.
Shipping Guide API
For 5800 Pakke til hentested and Servicepakke, leadtime responses (i.e requests with WithExpectedDelivery flag set to true) are now returning an expected delivery date based on historical data (ETA) instead of static calculations.
EDI documentation
New versions of the documents Appendix2 Available Services and Appendix 2A Instructions for service Implementation
Pickup Point API
The Pickup Point API now provides max parcel dimensions for Pakkeboks (parcel lockers in Norway).
Tracking API
The Tracking API now includes estimated arrival time window of delivery for supported shipments.
Pickup Point API
The Pickup Point API requires authentication for all.
Shipping Guide API
Extended leadtime information is available for Bedriftspakke (BPAKKE_DOR-DOR) and Pakke til bedrift (5000). Both services will now include the shipment’s estimated arrival time in addition to date.
Shipping Guide API
For Norwegian parcel services, unique alternative delivery dates can now be requested.
Booking API, Shipping Guide API
For Pickup Parcel (0340) and Pickup Parcel Bulk (0342) sent to Sweden and Denmark, Flex Delivery (0041) is no longer applicable as an additional service.
Booking API, Shipping Guide API
For Pickup Parcel (0340) and Pickup Parcel Bulk (0342) sent to Sweden and Denmark, Flex Delivery (0041) is no longer applicable as an additional service.
Event Cast API
Updated maximum length limit for header, also added the maximum length information for id, authenticator, content type and URL.
Shipping Guide API
INDOOR_LIGHT will be decomissioned from schema 11 and 12. Customers requesting this service in our Shipping Guide API must instead use 3332 as ID (note: only available in our latest version - schema 12)
Shipping Guide API
Added support to get estimated arrival time for requested pickup points in Shipping Guide API. On request of these new parameters (for REST API- estimateddeliverytime, pickuppoints and for SOAP V2- WithEstimatedDeliveryTime, PickupPoints), response will contain ’estimatedDeliveryTimes’, representing the estimated time of a parcel`s arrival at the respective pickup point(s).
Shipping Guide API
Added support for Green Delivery as a new tag in Shipping Guide response. Customers requesting Home Delivery services in our Shipping Guide API will get to know whether delivery to a specific postal code is green/fossil free or not.
Booking API, Shipping Guide API
Added mandatory weight
validation for cargo norway bookings along with
mandatory atleast one of Volume, Load meters, Dimensions, Pallets
Booking API, Shipping Guide API
Added mandatory weight
validation for cargo norway bookings along with
mandatory atleast one of Volume, Load meters, Dimensions, Pallets
Booking API
Added support for booking parcel services without measurements.
Event Cast API
Added support for new request parameter limit
. This can be used to limit the
number of latest webhooks returned.
Shipping Guide API
Decomissioned version 8 of the Shipping Guide API. Customers should use Shipping Guide API 2.0 instead.
Shipping Guide API
Added support for new request parameter addressLine
. Lead times for
Bedriftspakke, 5000, På døren and 5600 will be calculated based on postal code +
street address from July 07 2020.
Reports API
Updated Reports API with APIs used to get reports overview statistics and count of shipments by key events.
Mailbox Packet API
Decommissioned the API. Mailbox parcel services must be booked via the Booking API from the same date.
Booking API
Added support for sending booking confirmation e-mail if e-mail is specified in request. Can be applied to sender’s e-mail for outgoing services, and both sender’s/recipient’s e-mail for return services. Note that e-mail is optional and can at any time be skipped from the request.
Reports API
Added InvoiceSource
in metadata section of the response when specified invoice
report is generated.
Booking API, Shipping Guide API
Decommissioned Courier 6H for Norway from Booking API and Shipping Guide API.
Booking API, Shipping Guide API
Decommissioned Courier 6H for Norway from Booking API and Shipping Guide API.
Shipping Guide API
Decommissioned Home Delivery Mailbox from Shipping Guide API.
Event Cast API
Released Event Cast API, an API for getting event updates pushed instead of polling tracking.
Shipping Guide API
Decommissioned Småpakker from Shipping Guide API.
Invoice API
Added new attributes fromDate
and toDate
to specify period for fetching
invoices.
Shipping Guide API
Decommissioned version 9 of the Shipping Guide API. Customers should use Shipping Guide API 2.0 instead.
Shipping Guide API
Decommissioned version 7 of the Shipping Guide API. Customers should use Shipping Guide API 2.0 instead.
Booking API
It is now possible to pass customs declaration information that will be sent
electronically to the destination country, using the field
ediCustomsDeclarations
.
Mailbox Packet API, Shipping Guide API
Added support for bagOnDoor
, a delivery alternative for parcels that cannot be
delivered to the mailbox.
Booking API
Added new syntax for requesting pickup. Both ways are still supported, but they can’t be combined.
Warehousing API
Added new attribute OrderItem/ArticleMonetaryAmounts
that contains the article
unit sales price.
Booking API
Added new syntax for requesting additional services. Both ways are still supported, but they can’t be combined.
Shipping Guide API
Decommissioned version 1 and 2 of the Shipping Guide API. Customers should use Shipping Guide API 2.0 instead.
Modify Delivery API
Released Modify Delivery API, an API used to modify a shipment currently on its way.
Shipping Guide API
Decommissioned version 10 of the Shipping Guide API. Customers should use Shipping Guide API 2.0 instead.
Shipping Guide API
Decommissioned version 3 of the Shipping Guide API. Customers should use Shipping Guide API 2.0 instead.
Shipping Guide API
Decommissioned version 4, 5 and 6 of the Shipping Guide API. Customers should use Shipping Guide API 2.0 instead.
Warehousing API
The Order Management API split out of the Warehousing API. These will now continue as two separate APIs.