Skip to main content

Pickup API

The Pickup API is used to book ad hoc pickups.

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

Endpoints

Base URL
https://api.bring.com/pickup
Usage Method Endpoint
Order a pickup POST /api/create

OpenAPI document

https://api.bring.com/pickup/api-docs

Order a pickup

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

When booking 5100 Stykkgods til bedrift, pickup is added automatically, hence it is not needed in the API request.

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

array of objects
code
string
consignmentCorrelationId
string
array of objects
lang
string
message
string
packageCorrelationId
string
uniqueId
string
object
earliestPickupDate
Required
string <date-time>
isoFormattedEarliestPickupDateTime
ISO formatted date
string <date-time>
isoFormattedLatestPickupDateTime
ISO formatted date
string <date-time>
latestPickupDate
string <date-time>
packageNumber
string
status
Required
string
url
string
object
array wrapped
object
code
Required
string
consignmentCorrelationId
string attribute
Required
array wrapped
object
lang
string attribute
message
string
packageCorrelationId
string attribute
uniqueId
Required
string
object
earliestPickupDate
Required
string <date-time>
isoFormattedEarliestPickupDateTime
ISO formatted date
string <date-time>
isoFormattedLatestPickupDateTime
ISO formatted date
string <date-time>
latestPickupDate
string <date-time>
packageNumber
string
status
Required
string
url
string
400 Bad Request

Schema

array of objects
array of objects
code
string
consignmentCorrelationId
string
array of objects
lang
string
message
string
packageCorrelationId
string
uniqueId
string
object
earliestPickupDate
Required
string <date-time>
isoFormattedEarliestPickupDateTime
ISO formatted date
string <date-time>
isoFormattedLatestPickupDateTime
ISO formatted date
string <date-time>
latestPickupDate
string <date-time>
packageNumber
string
status
Required
string
url
string
array
object
array wrapped
object
code
Required
string
consignmentCorrelationId
string attribute
Required
array wrapped
object
lang
string attribute
message
string
packageCorrelationId
string attribute
uniqueId
Required
string
object
earliestPickupDate
Required
string <date-time>
isoFormattedEarliestPickupDateTime
ISO formatted date
string <date-time>
isoFormattedLatestPickupDateTime
ISO formatted date
string <date-time>
latestPickupDate
string <date-time>
packageNumber
string
status
Required
string
url
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",
  "testIndicator": true
}
<?xml version="1.0" encoding="UTF-8"?>
<pickupOrderRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
  <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"
  }
}
comments powered by Disqus