Skip to main content

Pickup API

Updates

Older updates

System maintenance

21 October 2025General

On 26 October we will do some system maintenance that will affect our APIs. You might experience some outage between 07:00 and 09:00 Sunday 26 October.

Important Update! New TLS certificates on api.bring.com 27th of October 2025

26 September 2025General

Migration from Buypass to Let’s Encrypt TLS Certificates As of 15 September 2025, Buypass has stopped allowing registration of new ACME Account and will stop generating/renewing TLS certificates from 15th October 2025. To ensure continuity, we are migrating all TLS certificates from Buypass to Let´s Encrypt.

As part of this activity:

  • Old Buypass certificates will be removed
  • New Let´s Encrypt certificates will be created

Impact to Customers:

  • If your application does not pin the certificate, no action is required and there will be zero impact.
  • If your application does pin the certificate, you will need to download the new Let´s Encrypt certificate and update your application configuration accordingly.

We recommend reviewing your applications to check whether certificate pinning is in place and preparing for updates if needed.

For more queries, contact integrasjon.norge@bring.com (Norway) or edi@bring.com (outside Norway).

Note! Removal of temporary domain api-new.bring.com

11 January 2023General

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).

Upcoming DNS change 1st of April 2022

21 December 2021General

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.

EDI documentation

8 June 2021General

New versions of the documents Appendix2 Available Services and Appendix 2A Instructions for service Implementation

The Pickup API enables you to book ad hoc pickup (to the terminal) when you don't have a fixed pickup agreement with Bring for your shipments. The API serves two main use cases:

  • Business Customers: Book ad hoc pickups for cargo shipments in Norway and for parcels and business pallets in NO/SE/DK.
  • C2C Platforms: Support customer ordering with mailbox pickup options, fetch available pickup dates, and modify or cancel pickups after booking.

Authentication

To integrate with the Bring APIs, you will need a Mybring user account with an API key. Information about prerequisites and authentication headers can be found on the general API Getting Started page. In addition to authentication, you need to be authorized.

Rate limiting

Clients exceeding a certain number of requests per second will be throttled, and the response will contain http status code 429. If you have a use case requiring rates above the limit, please contact developer-booking@bring.com for assistance.

Formats

REST JSON over HTTP is recommended for all new integrations. While we currently also support XML, this is very likely to be phased out in the future. Pickup endpoints will assume all requests are UTF-8 encoded.

Special topics

Where is ad hoc cargo pickup applicable?

For cargo services in Norway, ad hoc pickup orders are only applicable in the below scenarios.

Applicable:

  • 5400 if shipment not booked with pickup
  • 5100 if shipment not booked via Booking API (where pickup is always included)

Not applicable:

  • 5300
  • 5200

Available pickup types

The create endpoint for ad hoc pickup to business address supports the following types

  • PARCEL - Pickup of business parcel and pallet in Norway, Sweden and Denmark
  • CARGO - Cargo/freight Pickup

The Pickup Options endpoint supports the following shipment types:

  • PARCEL - Pickup of business parcel and pallet in Norway
  • CARGO - Cargo/freight Pickup
  • PARCEL_INTERNATIONAL - Pickup of business parcel and pallet in Sweden and Denmark
  • MAILBOX - Mailbox pickup for C2C platforms (customer picks up from their local mailbox)

Use Case Guide

For Business Customers

If you’re a business customer needing ad hoc pickups at your business address, use this API to:

  • Book cargo pickup in Norway (service 5400, 5100) through create endpoint
  • Book parcels and business pallets pickup across NO/SE/DK through create endpoint

For C2C Platforms

If you’re allowing customers to add pickup in the mailbox (vas 1073) to their shipments:

  • Use the Pickup Options endpoint to fetch available pickup dates
  • Allow customers to modify or cancel pickups after booking (parcels booked with service codes 3622, 5900, 5901, 5902 in Norway)

Modifying and Cancelling Pickups

Endpoints for modifying and cancelling pickups are currently available only for C2C parcels in Norway. Specifically, these operations are supported for parcels booked with service codes 3622, 5900, 5901, or 5902 that have mailbox pickup enabled (VAS 1073).

For Business Customers: If you need to make changes to an ad hoc pickup at your business address, direct API-based modification and cancellation are not currently available. Please contact our customer service team at developer-booking@bring.com to manage your pickup orders.

Endpoints

Base URL
https://api.bring.com/pickup
Usage Method Endpoint
Cancel a pickup order DELETE /api/cancel/{shipmentnumber}
Order a pickup POST /api/create
Modify a pickup order PUT /api/modify/{shipmentnumber}
Get available pickup options GET /api/pickup-options

Cancel a pickup order

DELETE
https://api.bring.com/pickup/api/cancel/{shipmentnumber}

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Your user's API key
Type
string

path parameters

shipmentnumber
Required
Description
Shipment number
Type
string

Responses

200 OK

Schema

Media type: application/json

object
message
Required
string
status
Required
string
400 Bad Request

Schema

Media type: application/json

object
message
Required
string
status
Required
string
401 Unauthorized

Schema

Media type: application/json

object
message
Required
string
status
Required
string
404 Not Found

Schema

Media type: application/json

object
message
Required
string
status
Required
string
429 Too Many Requests

Schema

Media type: application/json

object
message
Required
string
status
Required
string
500 Internal Server Error

Schema

Media type: application/json

object
message
Required
string
status
Required
string

Response examples

Cancel pickup success response

{
  "status": "ACCEPTED"
}

Order a pickup

POST
https://api.bring.com/pickup/api/create

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Your user's API key
Type
string
X-Bring-Test-Indicator
Required
Description
A boolean value indicating whether this is a test or not
Type
boolean

Body schema

countryCode
Required
Two-letter ISO-3166-1 country code
string
Required
object
companyName
Required
string
customerNumber
Required
string
Required
object
city
Required
string
contactName
string
deliveryInstruction
Delivery instruction to the driver
string
email
Required
stringMax length: 60
message
Generic message to the driver
string
phoneNumber
Required
string
postalCode
Required
string
street
Required
string
pickupDate
Required
string
object
numberOfPackages
Deprecated
This is deprecated. Use packages and count instead
integer <int32>
numberOfPallets
Deprecated
This is deprecated. Use pallets and count instead
integer <int32>
numberOfPostContainers
Deprecated
This is deprecated. Use postContainers and count instead
integer <int32>
object
count
Required
For giving number of packages. Applicable for parcel pickups in Norway and Nordics and cargo pickup
integer <int32>
volumeInDm3
Applicable and required for cargo pickup
number
weightInGrams
Applicable for parcel pickups in Norway and Nordics and required for cargo pickup
integer <int32>
object
count
Required
For giving number of pallets. Applicable for parcel pickups in Norway and Nordics
integer <int32>
weightInGrams
Applicable for parcel pickups in Norway and Nordics
integer <int32>
object
count
Required
For giving number of postContainers. Applicable for parcel pickups in Norway
integer <int32>
weightInGrams
Applicable for parcel pickups in Norway
integer <int32>
volumeInDm3
Deprecated
This is deprecated. Use packages and volumeInDm3 instead
number
weightInGrams
Applicable for pickup in Nordics
integer <int32>
pickupIsReadyAtTime
Currently not in use
string
pickupTimeZone
string
service
Required
The pickup service you want to book
string
Enum
PARCEL
CARGO
testIndicator
Deprecated
Deprecated, use HTTP header instead. For test orders, set this to true
boolean
object
countryCode
Required
Two-letter ISO-3166-1 country code
string
Required
object
companyName
Required
string
customerNumber
Required
string
Required
object
city
Required
string
contactName
string
deliveryInstructionToDriver
Delivery instruction to the driver
string
email
Required
stringMax length: 60
messageToDriver
Generic message to the driver
string
phoneNumber
Required
string
postalCode
Required
string
street
Required
string
pickupDate
Required
string
object
numberOfPackages
Deprecated
This is deprecated. Use packages and count instead
integer <int32>
numberOfPallets
Deprecated
This is deprecated. Use pallets and count instead
integer <int32>
numberOfPostContainers
Deprecated
This is deprecated. Use postContainers and count instead
integer <int32>
object
count
Required
For giving number of packages. Applicable for parcel pickups in Norway and Nordics and cargo pickup
integer <int32>
volumeInDm3
Applicable and required for cargo pickup
number
weightInGrams
Applicable for parcel pickups in Norway and Nordics and required for cargo pickup
integer <int32>
object
count
Required
For giving number of pallets. Applicable for parcel pickups in Norway and Nordics
integer <int32>
weightInGrams
Applicable for parcel pickups in Norway and Nordics
integer <int32>
object
count
Required
For giving number of postContainers. Applicable for parcel pickups in Norway
integer <int32>
weightInGrams
Applicable for parcel pickups in Norway
integer <int32>
volumeInDm3
Deprecated
This is deprecated. Use packages and volumeInDm3 instead
number
weightInGrams
Applicable for pickup in Nordics
integer <int32>
pickupIsReadyAtTime
Currently not in use
string
pickupTimeZone
string
service
Required
The pickup service you want to book
string
Enum
PARCEL
CARGO
testIndicator
Deprecated
Deprecated, use HTTP header instead. For test orders, set this to true
boolean attribute

Responses

200 OK

Schema

string
string
400 Bad Request

Schema

array of strings
string
array
string

Request examples

{
  "countryCode": "NO",
  "customerInformation": {
    "companyName": "Norsk Bedrift AS",
    "customerNumber": "*******"
  },
  "pickupAddress": {
    "city": "OSLO",
    "email": "norsk.bedrift@example.com",
    "message": "Hentes på baksiden",
    "phoneNumber": "+4712345678",
    "postalCode": "0263",
    "street": "Testsvingen 12"
  },
  "pickupDate": "2015-12-03",
  "pickupDetails": {
    "packages": {
      "count": 2,
      "volumeInDm3": 40,
      "weightInGrams": 1000
    }
  },
  "pickupIsReadyAtTime": null,
  "pickupTimeZone": "Europe/Oslo",
  "service": "CARGO"
}
<?xml version="1.0" encoding="UTF-8"?>
<pickupOrderRequest>
  <countryCode>NO</countryCode>
  <customerInformation>
    <companyName>Norsk Bedrift AS</companyName>
    <customerNumber>*******</customerNumber>
  </customerInformation>
  <pickupAddress>
    <city>OSLO</city>
    <email>norsk.bedrift@example.com</email>
    <messageToDriver>Hentes på baksiden</messageToDriver>
    <phoneNumber>+4712345678</phoneNumber>
    <postalCode>0263</postalCode>
    <street>Testsvingen 12</street>
  </pickupAddress>
  <pickupDate>2015-12-03</pickupDate>
  <pickupDetails>
    <packages>
      <count>2</count>
      <volumeInDm3>40</volumeInDm3>
      <weightInGrams>1000</weightInGrams>
    </packages>
  </pickupDetails>
  <pickupTimeZone>Europe/Oslo</pickupTimeZone>
  <service>CARGO</service>
</pickupOrderRequest>

Response examples

Pickup Order Response

{
  "errors": null,
  "pickupConfirmation": {
    "earliestPickupDate": 1720159200000,
    "isoFormattedEarliestPickupDateTime": "2024-05-27T08:00:00.000+00:00",
    "isoFormattedLatestPickupDateTime": "2024-05-27T16:00:00.000+00:00",
    "latestPickupDate": 1720188000000,
    "packageNumber": "123456789012345678",
    "status": "OK",
    "url": "https://www.mybring.com/order-pickup/receipt/xxxxxxxxx"
  }
}

Modify a pickup order

PUT
https://api.bring.com/pickup/api/modify/{shipmentnumber}

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Your user's API key
Type
string

path parameters

shipmentnumber
Required
Description
Shipment number
Type
string

Body schema

Media type: application/json

date
Required
string <date>

Responses

200 OK

Schema

Media type: application/json

object
message
Required
string
status
Required
string
400 Bad Request

Schema

Media type: application/json

object
message
Required
string
status
Required
string
401 Unauthorized

Schema

Media type: application/json

object
message
Required
string
status
Required
string
404 Not Found

Schema

Media type: application/json

object
message
Required
string
status
Required
string
429 Too Many Requests

Schema

Media type: application/json

object
message
Required
string
status
Required
string
500 Internal Server Error

Schema

Media type: application/json

object
message
Required
string
status
Required
string

Request examples

Modify pickup request

{
  "date": "2026-05-06"
}

Response examples

Modify pickup success response

{
  "status": "ACCEPTED"
}

Get available pickup options

GET
https://api.bring.com/pickup/api/pickup-options

Returns available pickup windows for a shipment context. `price` may be omitted.

Request

query parameters

type
Required
Description
Shipment type.
Type
string
Enum
PARCEL
PARCEL_INTERNATIONAL
CARGO
MAILBOX
Example
type=PARCEL
countryCode
Required
Description
Two-letter ISO-3166-1 country code
Type
string
Example
countryCode=false
shippingDate
Required
Description
Shipment date.
Type
string
Example
shippingDate=2026-05-15
postalCode
Required
Description
Postal code for pickup location.
Type
string
Example
postalCode=0150
numberOfAlternativePickupDates
Description
Number of additional pickup dates to return.
Type
number
Example
numberOfAlternativePickupDates=3
customerNumber
Description
Customer number for pricing.
Type
string
Example
customerNumber=123456789

Responses

200 OK

Schema

Media type: application/json

Required
array of objects
date
Required
string <date>
from
Required
string <time>
to
Required
string <time>
object
amountWithVAT
Required
number <double>
amountWithoutVAT
Required
number <double>
vat
Required
number <double>
400 Invalid request parameters.

Schema

Media type: application/json

Required
array of objects
code
Required
string
field
Required
string
message
Required
string

Response examples

Example response with price

{
  "pickupOptions": [
    {
      "date": "2026-05-15",
      "from": "08:00:00",
      "to": "16:00:00"
    },
    {
      "date": "2026-05-18",
      "from": "08:00:00",
      "to": "16:00:00"
    },
    {
      "date": "2026-05-19",
      "from": "08:00:00",
      "to": "16:00:00"
    },
    {
      "date": "2026-05-20",
      "from": "08:00:00",
      "to": "16:00:00"
    }
  ],
  "price": {
    "amountWithVAT": 535,
    "amountWithoutVAT": 428,
    "vat": 107
  }
}
comments powered by Disqus