Skip to main content

Booking API

SOAP endpoint deprecated

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, please 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.

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

The Booking API is used to book shipments and supports more than 60 different services as well as a variety of additional services. Each shipment is booked individually, and shipment number, tracking link, EDI-prenotification, label and other transport documents are created as part of the transaction. Additionally, it’s possible to book pickups. The API can also provide a list of supported services and countries based on your agreement with Bring (i.e. the customer numbers attached to your user). The Booking API has similarities with the Shipment API, but there are differences.

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 18 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 XML/JSON over HTTP. Booking endpoints will assume all requests are UTF-8 encoded.

Special topics

Endpoints

Base URL
https://api.bring.com/booking-api
Usage Method Endpoint
Make a booking POST /api/booking
List customer numbers and services GET /api/customers
Error codes GET /api/errors
Order a pickup POST /api/pickupOrder

Make a booking

post
                https://api.bring.com/booking-api/api/booking
              

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
Accept
Description
Specify response format
Type
string
Enum
application/json
application/xml
Content-Type
Description
Specify request format
Type
string
Enum
application/json
application/xml

Body schema

clientUid
string
clientUrl
string
Required
array of objects
correlationId
An identifier to correlate packages which belong to the same order
string
The alternative date and time window selected for preferred delivery by the customer. Applicable for outgoing Home Delivery services. Note Shipping Guide API must be used for getting the alternative delivery date and time windows before sending a booking request with the preferred alternative.
object
endDateTime
string <date-time>
startDateTime
string <date-time>
customerSpecifiedDeliveryDateTime
The date and time selected for preferred delivery by the customer. Note that for some services, the time part of this field will be ignored. This field is applicable for 5600 and Oil Express. For 5600 the date cannot be set to more than current date + 10 days
string <date-time>
customerSpecifiedDispatchDateTime
string <date-time>
generateQrCodes
Specifies whether QR codes are wanted in addition to the regular label for certain services. See Generating QR codes for more information
boolean
array of objects
containerId
This parameter is applicable (and required) for Oil Express
string
correlationId
string
object
heightInCm
Required
Height of the package in centimeters. Dimension is optional when volumeInDm3 is specified in the request for Cargo. See Measurements for Cargo and Home Delivery services for more information
integer <int32>
lengthInCm
Required
Length of the package in centimeters. Dimension is optional when volumeInDm3 is specified in the request for Cargo. See Measurements for Cargo and Home Delivery services for more information
integer <int32>
widthInCm
Required
Width of the package in centimeters. Dimension is optional when volumeInDm3 is specified in the request for Cargo. See Measurements for Cargo and Home Delivery services for more information
integer <int32>
goodsDescription
Describes what is inside the package
stringMax length: 35
isStackable
This parameter is applicable when packageType is pallet
boolean
loadMeters
Load meters (when request is for Cargo). Maximum value is 49.9. See Measurements for Cargo and Home Delivery services for more information
number <double>
numberOfItems
Number of items within a package. This parameter is applicable for Cargo, Oil Express and Home Delivery services
integer <int32>
numberOfPallets
Number of pallets (when request is for Cargo). See Measurements for Cargo and Home Delivery services for more information
integer <int32>
packageType
string
Enum
QuickPack Envelope - envelope
Cargo services - package
Cargo/pallet services - pallet
Cargo/pallet services - half-pallet
Cargo/pallet services - quarter-pallet
Oil Express - ox_unit
Oil Express - ox_tank
Oil Express - ox_container
Oil Express - ox_basket
Oil Express - ox_pallet
Oil Express - ox_other
Home Delivery services - hd_eur
Home Delivery services - hd_half
Home Delivery services - hd_quarter
Home Delivery services - hd_loose
volumeInDm3
Volume in cubic decimeters. See Measurements for Cargo and Home Delivery services for more information
number <double>
weightInKg
Weight in kilograms
number <double>
object
Applicable for Cargo International
object
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
vatNumber
Organisation number
stringMax length: 12
Applicable for Cargo International
object
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
vatNumber
Organisation number
stringMax length: 12
See Customs information for more information
object
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
vatNumber
Organisation number
stringMax length: 12
object
countryCode
Required
string
id
Required
string
Required
object
additionalAddressInfo
Specifies a pickup/delivery instruction which will be shown on labels (and any waybills). Applicable for the Norwegian parcel services Pakke til bedrift (5000) and Ekspress neste dag (4850), as well as Cargo Norway domestic-services (all), Cargo International, Oil Express and Courier & Express services (all)
stringMax length: 70
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
Contact details
object
email
stringMax length: 60
name
string
phoneNumber
string
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
reference
Your internal order number that can be used for tracking. Please avoid using any personal data here since sender's reference is accessible in open tracking
stringMax length: 35
vatNumber
Organisation number
stringMax length: 12
Specifies a different return address than your actual sender address. When this tag is populated, the input will replace your actual sender address on the top left corner of the label. Only applicable to Pakke i Postkassen (Mailbox Parcel)
object
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
Required
object
additionalAddressInfo
Specifies a pickup/delivery instruction which will be shown on labels (and any waybills). Applicable for the Norwegian parcel services Pakke til bedrift (5000) and Ekspress neste dag (4850), as well as Cargo Norway domestic-services (all), Cargo International, Oil Express and Courier & Express services (all)
stringMax length: 70
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
Contact details
object
email
Specify an e-mail address if you want a booking confirmation e-mail to be sent
stringMax length: 60
name
string
phoneNumber
Contact phone number. Note that sender phone number is a mandatory field for all outgoing services. Exceptions to this rule are Pakke i Postkassen (Mailbox Parcel) and all return services
string
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
reference
Your internal order number that can be used for tracking. Please avoid using any personal data here since sender's reference is accessible in open tracking
stringMax length: 35
vatNumber
Organisation number
stringMax length: 12
object
array of objects
code
string
id
See the API service portfolio for further information on the different VASes
string
Enum
1000
POSTOPPKRAV
2084
EVARSLING
0041
SIMPLE_DELIVERY
0068
INSURANCE
1062
LORDAGSUTKJORING
0015
EVE_DELIVERY
2086
2141
NON_FREEZE
1142
PHONENOTIFICATION
1245
DANGEROUS_GOODS
OX_EXPRESS
ADVISERING
DELIVERY_INDOOR
FLEX_DELIVERY
ENVELOPE
1083
1288
1081
1073
SOSIAL_KONTROLL
1280
1133
LEGITIMASJONSPLIKT
1134
1094
1179
1165
1122
1123
1139
1124
1125
1140
1141
1342
2012
1127
1128
0003
1149
1163
2221
1095
1371
1380
1385
1362
1377
1378
customerNumber
Required
API customer number
stringMax length: 35
object
array of objects
countryOfOrigin
The country code of origin of the articles in an ediCustomsDeclaration line. This parameter must be 2 characters long
string
currency
The currency code used in an ediCustomsDeclaration line. This parameter must be 3 characters long
string
customsArticleNumber
string
goodsDescription
Describes what is inside the package
stringMax length: 35
itemNetWeightInKg
The weight (in kg) of all the articles declared in an ediCustomsDeclaration line
string
quantity
The number of articles in an ediCustomsDeclaration line
string
tarriffLineAmount
The value of all the articles declared in an ediCustomsDeclaration line
string
iossNumber
Import One-Stop Shop (IOSS) number used for customs export from Norway to EU. It must be in the format IMxxxxxxxxxx (10 digits). Only valid when natureOfTransaction is of type SALE_OF_GOODS. Note that this field cannot be combined with a reference field on the sender party
string
natureOfTransaction
Required
Specifies the purpose of the transaction
string
Enum
SALE_OF_GOODS
RETURNED_GOODS
GIFT
COMMERCIAL_SAMPLE
DOCUMENTS
OTHER
otherNatureOfTransactionDescription
string
id
Required
string
incotermRule
See Incoterms for Cargo International for more information
string
Enum
DDP
DAP
FCA
EXW
messageForRecipient
This parameter is applicable for Oil Express
stringMax length: 400
nonStandardCourierProductCode
Specifies the product code for customized courier services. This field is mandatory when request is for Non Standard Courier
string
object
deliveryOption
See Delivery attempts for more information
string
whoPaysInvoice
Specifies which party will pay the invoice for the booking
string
Enum
sender
recipient
thirdParty
Specifies the return service which should be used to generate a return shipment along with the outgoing shipment. See Free return of parcels for more information
object
id
Required
string
shippingDateTime
The date and time when an order is ready to be transported. The label generated against a booking will be valid for 52 weeks when Bring receives the request for an order
string <date-time>
schemaVersion
Required
Currently, it is 1
integer <int32>
testIndicator
Required
For test bookings, set this to true
boolean
object
clientUid
string
clientUrl
string
Required
array wrapped
object
correlationId
An identifier to correlate packages which belong to the same order
string attribute
The alternative date and time window selected for preferred delivery by the customer. Applicable for outgoing Home Delivery services. Note Shipping Guide API must be used for getting the alternative delivery date and time windows before sending a booking request with the preferred alternative.
object
endDateTime
string <date-time>
startDateTime
string <date-time>
customerSpecifiedDeliveryDateTime
The date and time selected for preferred delivery by the customer. Note that for some services, the time part of this field will be ignored. This field is applicable for 5600 and Oil Express. For 5600 the date cannot be set to more than current date + 10 days
string <date-time>
customerSpecifiedDispatchDateTime
string <date-time>
generateQrCodes
Specifies whether QR codes are wanted in addition to the regular label for certain services. See Generating QR codes for more information
boolean
array
object
containerId
This parameter is applicable (and required) for Oil Express
string
correlationId
string attribute
object
heightInCm
Required
Height of the package in centimeters. Dimension is optional when volumeInDm3 is specified in the request for Cargo. See Measurements for Cargo and Home Delivery services for more information
integer <int32>
lengthInCm
Required
Length of the package in centimeters. Dimension is optional when volumeInDm3 is specified in the request for Cargo. See Measurements for Cargo and Home Delivery services for more information
integer <int32>
widthInCm
Required
Width of the package in centimeters. Dimension is optional when volumeInDm3 is specified in the request for Cargo. See Measurements for Cargo and Home Delivery services for more information
integer <int32>
goodsDescription
Describes what is inside the package
stringMax length: 35
isStackable
This parameter is applicable when packageType is pallet
boolean
loadMeters
Load meters (when request is for Cargo). Maximum value is 49.9. See Measurements for Cargo and Home Delivery services for more information
number <double>
numberOfItems
Number of items within a package. This parameter is applicable for Cargo, Oil Express and Home Delivery services
integer <int32>
numberOfPallets
Number of pallets (when request is for Cargo). See Measurements for Cargo and Home Delivery services for more information
integer <int32>
packageType
string
Enum
QuickPack Envelope - envelope
Cargo services - package
Cargo/pallet services - pallet
Cargo/pallet services - half-pallet
Cargo/pallet services - quarter-pallet
Oil Express - ox_unit
Oil Express - ox_tank
Oil Express - ox_container
Oil Express - ox_basket
Oil Express - ox_pallet
Oil Express - ox_other
Home Delivery services - hd_eur
Home Delivery services - hd_half
Home Delivery services - hd_quarter
Home Delivery services - hd_loose
volumeInDm3
Volume in cubic decimeters. See Measurements for Cargo and Home Delivery services for more information
number <double>
weightInKg
Weight in kilograms
number <double>
Required
object
Applicable for Cargo International
object
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
vatNumber
Organisation number
stringMax length: 12
Applicable for Cargo International
object
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
vatNumber
Organisation number
stringMax length: 12
See Customs information for more information
object
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
vatNumber
Organisation number
stringMax length: 12
object
countryCode
Required
string
id
Required
string
Required
object
additionalAddressInfo
Specifies a pickup/delivery instruction which will be shown on labels (and any waybills). Applicable for the Norwegian parcel services Pakke til bedrift (5000) and Ekspress neste dag (4850), as well as Cargo Norway domestic-services (all), Cargo International, Oil Express and Courier & Express services (all)
stringMax length: 70
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
Contact details
object
email
stringMax length: 60
name
string
phoneNumber
string
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
reference
Your internal order number that can be used for tracking. Please avoid using any personal data here since sender's reference is accessible in open tracking
stringMax length: 35
vatNumber
Organisation number
stringMax length: 12
Specifies a different return address than your actual sender address. When this tag is populated, the input will replace your actual sender address on the top left corner of the label. Only applicable to Pakke i Postkassen (Mailbox Parcel)
object
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
Required
object
additionalAddressInfo
Specifies a pickup/delivery instruction which will be shown on labels (and any waybills). Applicable for the Norwegian parcel services Pakke til bedrift (5000) and Ekspress neste dag (4850), as well as Cargo Norway domestic-services (all), Cargo International, Oil Express and Courier & Express services (all)
stringMax length: 70
addressLine
Required
stringMax length: 35
addressLine2
stringMax length: 35
city
Required
stringMax length: 35
Contact details
object
email
Specify an e-mail address if you want a booking confirmation e-mail to be sent
stringMax length: 60
name
string
phoneNumber
Contact phone number. Note that sender phone number is a mandatory field for all outgoing services. Exceptions to this rule are Pakke i Postkassen (Mailbox Parcel) and all return services
string
countryCode
Required
Two-letter ISO-3166-1 country code
string
name
Required
string
postalCode
Required
string
reference
Your internal order number that can be used for tracking. Please avoid using any personal data here since sender's reference is accessible in open tracking
stringMax length: 35
vatNumber
Organisation number
stringMax length: 12
Required
object
array
object
code
string
id
Required
See the API service portfolio for further information on the different VASes
string
Enum
1000
POSTOPPKRAV
2084
EVARSLING
0041
SIMPLE_DELIVERY
0068
INSURANCE
1062
LORDAGSUTKJORING
0015
EVE_DELIVERY
2086
2141
NON_FREEZE
1142
PHONENOTIFICATION
1245
DANGEROUS_GOODS
OX_EXPRESS
ADVISERING
DELIVERY_INDOOR
FLEX_DELIVERY
ENVELOPE
1083
1288
1081
1073
SOSIAL_KONTROLL
1280
1133
LEGITIMASJONSPLIKT
1134
1094
1179
1165
1122
1123
1139
1124
1125
1140
1141
1342
2012
1127
1128
0003
1149
1163
2221
1095
1371
1380
1385
1362
1377
1378
customerNumber
Required
API customer number
stringMax length: 35
object
array
object
countryOfOrigin
The country code of origin of the articles in an ediCustomsDeclaration line. This parameter must be 2 characters long
string
currency
Required
The currency code used in an ediCustomsDeclaration line. This parameter must be 3 characters long
string
customsArticleNumber
string
goodsDescription
Required
Describes what is inside the package
stringMax length: 35
itemNetWeightInKg
Required
The weight (in kg) of all the articles declared in an ediCustomsDeclaration line
string
quantity
Required
The number of articles in an ediCustomsDeclaration line
string
tarriffLineAmount
Required
The value of all the articles declared in an ediCustomsDeclaration line
string
iossNumber
Import One-Stop Shop (IOSS) number used for customs export from Norway to EU. It must be in the format IMxxxxxxxxxx (10 digits). Only valid when natureOfTransaction is of type SALE_OF_GOODS. Note that this field cannot be combined with a reference field on the sender party
string
natureOfTransaction
Required
Specifies the purpose of the transaction
string
Enum
SALE_OF_GOODS
RETURNED_GOODS
GIFT
COMMERCIAL_SAMPLE
DOCUMENTS
OTHER
otherNatureOfTransactionDescription
string
id
Required
string
incotermRule
See Incoterms for Cargo International for more information
string
Enum
DDP
DAP
FCA
EXW
messageForRecipient
This parameter is applicable for Oil Express
stringMax length: 400
nonStandardCourierProductCode
Specifies the product code for customized courier services. This field is mandatory when request is for Non Standard Courier
string
object
deliveryOption
See Delivery attempts for more information
string
whoPaysInvoice
Specifies which party will pay the invoice for the booking
string
Enum
sender
recipient
thirdParty
Specifies the return service which should be used to generate a return shipment along with the outgoing shipment. See Free return of parcels for more information
object
id
Required
string
shippingDateTime
Required
The date and time when an order is ready to be transported. The label generated against a booking will be valid for 52 weeks when Bring receives the request for an order
string <date-time>
schemaVersion
Required
Currently, it is 1
integer <int32>
testIndicator
Required
For test bookings, set this to true
boolean attribute

Responses

200 OK

Schema

Required
array of objects
object
consignmentNumber
Required
string
object
earliestPickup
string <date-time>
expectedDelivery
string <date-time>
id
integer <int64>
Required
object
labelArchiveUrl
string
labels
string
tracking
Required
string
waybill
string
Required
array of objects
correlationId
string
labelFreeCode
string
packageNumber
string
qrCodeLink
string
object
upsShipmentNumber
string
upsTrackingNumber
string
returnConsignmentNumber
string
object
labelArchiveUrl
string
labels
string
tracking
Required
string
waybill
string
correlationId
string
array of objects
code
string
consignmentCorrelationId
string
array of objects
lang
string
message
string
packageCorrelationId
string
uniqueId
string
object
Required
array wrapped
object
object
consignmentNumber
Required
string
object
earliestPickup
string <date-time>
expectedDelivery
string <date-time>
id
integer <int64>
Required
object
labelArchiveUrl
string
labels
string
tracking
Required
string
waybill
string
Required
array wrapped
object
correlationId
string attribute
labelFreeCode
string
packageNumber
Required
string
qrCodeLink
string
object
upsShipmentNumber
string
upsTrackingNumber
string
returnConsignmentNumber
string
object
labelArchiveUrl
string
labels
string
tracking
Required
string
waybill
string
correlationId
string attribute
array wrapped
object
code
Required
string
consignmentCorrelationId
string attribute
Required
array wrapped
object
lang
string attribute
message
string
packageCorrelationId
string attribute
uniqueId
Required
string
400 Bad Request

Schema

array of objects
array of objects
object
consignmentNumber
Required
string
object
earliestPickup
string <date-time>
expectedDelivery
string <date-time>
id
integer <int64>
Required
object
labelArchiveUrl
string
labels
string
tracking
Required
string
waybill
string
Required
array of objects
correlationId
string
labelFreeCode
string
packageNumber
string
qrCodeLink
string
object
upsShipmentNumber
string
upsTrackingNumber
string
returnConsignmentNumber
string
object
labelArchiveUrl
string
labels
string
tracking
Required
string
waybill
string
correlationId
string
array of objects
code
string
consignmentCorrelationId
string
array of objects
lang
string
message
string
packageCorrelationId
string
uniqueId
string
array
object
Required
array wrapped
object
object
consignmentNumber
Required
string
object
earliestPickup
string <date-time>
expectedDelivery
string <date-time>
id
integer <int64>
Required
object
labelArchiveUrl
string
labels
string
tracking
Required
string
waybill
string
Required
array wrapped
object
correlationId
string attribute
labelFreeCode
string
packageNumber
Required
string
qrCodeLink
string
object
upsShipmentNumber
string
upsTrackingNumber
string
returnConsignmentNumber
string
object
labelArchiveUrl
string
labels
string
tracking
Required
string
waybill
string
correlationId
string attribute
array wrapped
object
code
Required
string
consignmentCorrelationId
string attribute
Required
array wrapped
object
lang
string attribute
message
string
packageCorrelationId
string attribute
uniqueId
Required
string

Request examples

{
  "consignments": [
    {
      "correlationId": "INTERNAL-123456",
      "packages": [
        {
          "correlationId": "PACKAGE-123",
          "dimensions": {
            "heightInCm": 10,
            "lengthInCm": 10,
            "widthInCm": 10
          },
          "weightInKg": 1.1
        }
      ],
      "parties": {
        "consignee": {
          "additionalAddressInfo": "Ring the doorbell",
          "addressLine": "Mottakerveien 14",
          "addressLine2": "c/o Tina Mottaker",
          "city": "BERLIN",
          "contact": {
            "email": "tore@mottakertest.no",
            "name": "Tore Mottaker",
            "phoneNumber": "+49301234567"
          },
          "countryCode": "DE",
          "name": "Tore Mottaker",
          "postalCode": "10115",
          "reference": "43242",
          "vatNumber": "1000-1028527"
        },
        "consignor": {
          "additionalAddressInfo": "Some pickup info",
          "addressLine": "Testsvingen 12",
          "addressLine2": "Testsvingen 12",
          "city": "OSLO",
          "contact": {
            "email": "trond@normanntest.no",
            "name": "Trond Nordmann",
            "phoneNumber": "+4712345678"
          },
          "countryCode": "no",
          "name": "Ola Nordmann",
          "postalCode": "0263",
          "reference": "1234",
          "vatNumber": "1000-1028527"
        },
        "recipient": {
          "additionalAddressInfo": "Ring the doorbell",
          "addressLine": "Mottakerveien 14",
          "addressLine2": "c/o Tina Mottaker",
          "city": "BERLIN",
          "contact": {
            "email": "tore@mottakertest.no",
            "name": "Tore Mottaker",
            "phoneNumber": "+49301234567"
          },
          "countryCode": "DE",
          "name": "Tore Mottaker",
          "postalCode": "10115",
          "reference": "43242"
        },
        "sender": {
          "additionalAddressInfo": "Some pickup info",
          "addressLine": "Testsvingen 12",
          "addressLine2": "Testsvingen 12",
          "city": "OSLO",
          "contact": {
            "email": "trond@normanntest.no",
            "name": "Trond Nordmann",
            "phoneNumber": "+4712345678"
          },
          "countryCode": "no",
          "name": "Ola Nordmann",
          "postalCode": "0263",
          "reference": "1234"
        }
      },
      "product": {
        "customerNumber": "CARGO-******",
        "id": "CARGO_INTERNATIONAL",
        "incotermRule": "DDP"
      },
      "shippingDateTime": 1470846939000
    }
  ],
  "schemaVersion": 1,
  "testIndicator": true
}
<?xml version="1.0" encoding="UTF-8"?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
  <consignments>
    <consignment correlationId="123456">
      <packages>
        <package correlationId="123">
          <loadMeters>1</loadMeters>
          <numberOfPallets>2</numberOfPallets>
          <volumeInDm3>2</volumeInDm3>
          <weightInKg>50</weightInKg>
        </package>
      </packages>
      <parties>
        <recipient>
          <addressLine>Mottakerveien 14</addressLine>
          <addressLine2>c/o Tina Recipient</addressLine2>
          <city>Glostrup</city>
          <contact>
            <email>tore@mottakertest.no</email>
            <name>Tore Recipient</name>
            <phoneNumber>+4791234567</phoneNumber>
          </contact>
          <countryCode>NO</countryCode>
          <name>Tore Recipient</name>
          <postalCode>5954</postalCode>
        </recipient>
        <sender>
          <additionalAddressInfo>Some pickup info</additionalAddressInfo>
          <addressLine>Testsvingen 12</addressLine>
          <city>Fredriksberg</city>
          <contact>
            <email>trond@normanntest.no</email>
            <name>Trond Nordmann</name>
            <phoneNumber>+4712345678</phoneNumber>
          </contact>
          <countryCode>NO</countryCode>
          <name>Ola Danske</name>
          <postalCode>4010</postalCode>
        </sender>
      </parties>
      <product>
        <customerNumber>***********</customerNumber>
        <id>5100</id>
      </product>
      <shippingDateTime>1470358449000</shippingDateTime>
    </consignment>
  </consignments>
  <schemaVersion>1</schemaVersion>
</bookingRequest>

Response examples

{
  "consignments": [
    {
      "confirmation": {
        "consignmentNumber": "70438101263797410",
        "dateAndTimes": {
          "expectedDelivery": "2022-06-28T22:00:00.000+00:00"
        },
        "links": {
          "labels": "http://www.bring.no/label.pdf",
          "tracking": "https://sporing.posten.no/sporing/70438101263797410"
        },
        "packages": [
          {
            "packageNumber": "1234"
          }
        ]
      }
    }
  ]
}

List customer numbers and services

get
                https://api.bring.com/booking-api/api/customers
              

Request

header parameters

X-Mybring-API-Uid
Required
Type
string
X-Mybring-API-Key
Required
Type
string

Responses

200 OK

Schema

Required
array of objects
countryCode
string
customerNumber
string
name
string
products
array of strings
string
object
Required
array wrapped
object
countryCode
Required
string
customerNumber
Required
string
name
Required
string
Required
array wrapped
product
string

Response examples

{
  "customers": [
    {
      "countryCode": "NO",
      "customerNumber": "5",
      "name": "Demo customer (00000000005)",
      "products": [
        "3570",
        "3584",
        "4850",
        "5000",
        "5600",
        "5800",
        "9000",
        "9300",
        "9600",
        "9650",
        "BUSINESS_HALFPALLET",
        "BUSINESS_PALLET",
        "BUSINESS_PARCEL",
        "BUSINESS_PARCEL_BULK",
        "BUSINESS_QUARTERPALLET",
        "EXPRESS_NORDIC_0900",
        "EXPRESS_NORDIC_0900_BULK",
        "HOME_DELIVERY_PARCEL",
        "PICKUP_PARCEL",
        "PICKUP_PARCEL_BULK"
      ]
    },
    {
      "countryCode": "SE",
      "customerNumber": "6",
      "name": "Demo customer (00000000006)",
      "products": [
        "0345",
        "BUSINESS_HALFPALLET",
        "BUSINESS_PALLET",
        "BUSINESS_PARCEL",
        "BUSINESS_PARCEL_BULK",
        "BUSINESS_QUARTERPALLET",
        "EXPRESS_NORDIC_0900",
        "EXPRESS_NORDIC_0900_BULK",
        "HOME_DELIVERY_PARCEL",
        "PICKUP_PARCEL",
        "PICKUP_PARCEL_BULK"
      ]
    }
  ]
}

Error codes

get
                https://api.bring.com/booking-api/api/errors
              

Request

header parameters

X-Mybring-API-Uid
Required
Type
string
X-Mybring-API-Key
Required
Type
string

Responses

200 OK

Schema

Required
array of objects
code
string
message
string
suffixable
boolean
object
Required
array wrapped
object
code
Required
string
message
Required
string
suffixable
Required
boolean

Response examples

{
  "errorTypes": [
    {
      "code": "BOOK-INPUT-001",
      "message": "Bad request",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-002",
      "message": "Weight is required",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-003",
      "message": "Schema version must be present",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-004",
      "message": "At least one consignment must be specified",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-005",
      "message": "Multiple consignments in one booking is not supported",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-006",
      "message": "Sender must be specified",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-007",
      "message": "Recipient must be specified",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-008",
      "message": "Product must be set",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-009",
      "message": "Package or Package Group must be specified",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-011",
      "message": "Multiple packages in one booking is not supported",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-012",
      "message": "Shipping date and time must be provided",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-013",
      "message": "Volume or Package dimensions must be provided",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-014",
      "message": "Name must be provided",
      "suffixable": true
    },
    {
      "code": "BOOK-INPUT-015",
      "message": "Address must be provided",
      "suffixable": true
    },
    {
      "code": "BOOK-INPUT-016",
      "message": "City must be provided",
      "suffixable": true
    },
    {
      "code": "BOOK-INPUT-017",
      "message": "ISO Country code must be provided",
      "suffixable": true
    },
    {
      "code": "BOOK-INPUT-018",
      "message": "Product ID must be provided",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-019",
      "message": "Customer number must be provided",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-020",
      "message": "Invalid product ID",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-021",
      "message": "Invalid customer number",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-022",
      "message": "Illegal product for country",
      "suffixable": true
    },
    {
      "code": "BOOK-INPUT-023",
      "message": "The shipment is too big to send with the given product",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-024",
      "message": "The product is not available between the given addresses (outside coverage)",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-025",
      "message": "The product is not available between the given countries",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-026",
      "message": "The product is not available as express between the given addresses (outside coverage)",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-027",
      "message": "Failed because of product specific requirements",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-028",
      "message": "Invalid country code",
      "suffixable": true
    },
    {
      "code": "BOOK-INPUT-029",
      "message": "Invalid customer number for sender country and product",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-030",
      "message": "Please set the testIndicator attribute on the request (true = test booking, false = production booking)",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-031",
      "message": "You must specify number of packages (pieces) included in the package group",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-032",
      "message": "Multiple packages are not supported for this product",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-033",
      "message": "Package groups are not supported for this product (numberOfItems cannot be greater than 1)",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-034",
      "message": "Multiple package groups are not supported for this product",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-035",
      "message": "Invalid value for QuickPack Envelope. Must be boolean lower case.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-036",
      "message": "Invalid currency code, use ISO 4217 currency code",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-037",
      "message": "Missing required input for cash on delivery. amount, currency and account are required.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-038",
      "message": "Invalid message type for cash on delivery.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-039",
      "message": "Delivery option is invalid.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-040",
      "message": "Delivery option is not applicable for this product.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-041",
      "message": "Invalid purchase order number",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-043",
      "message": "The customer does not have a return agreement for that country/product.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-044",
      "message": "Missing required input for cash on delivery. account type is required for Sweden.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-045",
      "message": "Could not find a pickup point for the provided recipient",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-046",
      "message": "Non freeze should be lowercase true or false.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-047",
      "message": "Pickup point delivery method is only available for PICKUP_PARCEL from other countries than Norway to Denmark and Sweden, PICKUP_PARCEL_BULK to Denmark, Norway, Sweden, Finland and for SERVICEPAKKE, 4850, 5000, 5800 and 3067 within NORWAY.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-048",
      "message": "Missing required UNNumber for Dangerous goods.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-049",
      "message": "Missing required Commodity for Dangerous goods.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-050",
      "message": "Missing required Weight for Dangerous goods.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-052",
      "message": "Missing required Container Id for Oil Express Product",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-053",
      "message": "Dangerous Goods Container Id should match with one of the container Id in Package List",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-054",
      "message": "Invalid amount for Cash On Delivery, use amount with two decimal places only",
      "suffixable": false
    },
    {
      "code": "BOOK_INPUT-055",
      "message": "Dangerous Goods is not supported for given product",
      "suffixable": false
    },
    {
      "code": "BOOK_INPUT-057",
      "message": "Invalid postal Code",
      "suffixable": true
    },
    {
      "code": "BOOK_INPUT-059",
      "message": "Invalid input provided. Not able to parse the input successfully.",
      "suffixable": false
    },
    {
      "code": "BOOK_INPUT-060",
      "message": "Missing booking request",
      "suffixable": false
    },
    {
      "code": "BOOK_INPUT-061",
      "message": "Maximum 400 characters are allowed in Message For Recipient field.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-062",
      "message": "Missing required message input for delivery indoor",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-063",
      "message": "Consignor must be specified",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-064",
      "message": "Consignee must be specified",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-065",
      "message": "Incoterm must be specified",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-066",
      "message": "Valid temperature zones are: frozen, cool, dry, fish",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-068",
      "message": "Package type must be specified for given product.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-070",
      "message": "The product is not available",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-071",
      "message": "Invalid package type for Home Delivery product. Available options: 'hd_eur', 'hd_half', 'hd_quarter', 'hd_loose'",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-072",
      "message": "Missing both recipient phone number and mobile number.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-073",
      "message": "Invalid package type for Home Delivery product. Available options: 'hd_eur', 'hd_half', 'hd_loose'",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-074",
      "message": "Only one of [packages, packageGroups] can be set",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-075",
      "message": "Dangerous goods cannot be booked with simple delivery",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-077",
      "message": "Additional services cannot be requested in combination of both old and new way. Use one way of requesting additional service.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-078",
      "message": "Invalid tarriff line amount",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-079",
      "message": "Invalid quantity",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-080",
      "message": "Additional services cannot be requested in this way, Check proper format for XML/JSON at https://developer.bring.com/api/booking/",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-081",
      "message": "When booking nonstandard courier services you must supply the 'nonStandardCourierProductCode'",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-082",
      "message": "'nonStandardCourierProductCode' can only be set when booking courier customized services",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-083",
      "message": "Invalid Return Product ID",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-084",
      "message": "QR codes cannot be ordered for product",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-085",
      "message": "Missing required weight or volume for Dangerous goods.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-086",
      "message": "Either weight or volume, not both, should be specified for Dangerous goods.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-087",
      "message": "Total weight of dangerous goods can not exceed total package weight.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-088",
      "message": "Total volume of dangerous goods can not exceed total package volume.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-089",
      "message": "Duplicated container ids for Oil Express w ADRs.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-090",
      "message": "Invalid dimensions for parcel box pickup point.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-091",
      "message": "Invalid length for UN Number. Must be of length four.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-092",
      "message": "Invalid Pickup Point type for this service.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-093",
      "message": "Missing required message input for desktop delivery.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-094",
      "message": "Customer does not have a bulk agreement for this sender country.",
      "suffixable": false
    },
    {
      "code": "BOOK_INPUT-095",
      "message": "Customer does not have a bulk agreement.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-096",
      "message": "Customer has multiple bulk agreements on sender country.",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-097",
      "message": "Customer does not have a bulk agreement for this sender/recipient country combination",
      "suffixable": false
    },
    {
      "code": "BOOK-INPUT-098",
      "message": "Valid recipient mobile number is required for delivery to locker",
      "suffixable": false
    },
    {
      "code": "BOOK-AUTHORIZATION-001",
      "message": "Your user is not authorized to perform this action",
      "suffixable": false
    },
    {
      "code": "BOOK-VALIDATION-001",
      "message": "Unexpected business validation rule failure",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-002",
      "message": "A valid mobile phone number or email address is required for eVarsling",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-003",
      "message": "Country is not a member of Universal Postal Union",
      "suffixable": true
    },
    {
      "code": "BOOK_VALIDATION-004",
      "message": "Phone Notification is not available for the recipient country.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-005",
      "message": "Phone Notification should be true.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-006",
      "message": "Phone Notification requires recipient number to be present.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-008",
      "message": "Illegal argument",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-009",
      "message": "Booking of this revised service is only supported using your main customer number. This customer number also needs to be converted to the agreements covering the revised service.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-010",
      "message": "Booking of this service is not supported using this main customer number. You have to use the customer number belonging to the corresponding service type.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-011",
      "message": "A valid recipient mobile number or email address is required for notification",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-012",
      "message": "A valid quantity, goods description, tariff line amount and item net weight is required for customs declaration",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-013",
      "message": "Nature of transaction required for using customs declarations",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-014",
      "message": "Customs declarations are required for exporting this product from Norway",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-015",
      "message": "Total weight stated in the customs information exceeds the allowed max weight for this service",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-016",
      "message": "One or more additional services is not allowed for this customer",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-017",
      "message": "Main customer number must be used for this service",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-018",
      "message": "One or more additional services is not valid for this service",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-019",
      "message": "Maximum 10 dangerous goods vases are allowed in a request",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-020",
      "message": "A valid quantity, goods description, tariff code, item net weight, amount, currency and country of origin is required for import customs declaration",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-021",
      "message": "A valid VOEC (VAT On Ecommerce) id is not present, it should be 7 digits",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-022",
      "message": "Nature of transaction must be SALE_OF_GOODS",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-023",
      "message": "Invalid incoterm for this shipment",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-024",
      "message": "Customs declaration requires country of origin for this service when shipped from Norway",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-025",
      "message": "The supplied IOSS number is invalid. Should consist of 'IM' and 10 digits.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-026",
      "message": "An IOSS number is provided for a recipient country that does not qualify for IOSS.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-027",
      "message": "An IOSS number is provided as well as a senders reference. This is not supported.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-028",
      "message": "An IOSS number is provided for a nature of transaction other than SALE_OF_GOODS.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-029",
      "message": "You cannot use tag numberOfPallets for this product. Add the number in the numberOfItems tag.",
      "suffixable": false
    },
    {
      "code": "BOOK-VALIDATION-030",
      "message": "Limited quantities gross weight is mandatory when shipment route involves a boat",
      "suffixable": false
    },
    {
      "code": "BOOK-VALIDATION-031",
      "message": "Limited quantities gross weight can not be greater than shipment total weight",
      "suffixable": false
    },
    {
      "code": "BOOK-VALIDATION-032",
      "message": "Provided recipient address is unknown. Could not complete booking without valid address",
      "suffixable": false
    },
    {
      "code": "BOOK-VALIDATION-033",
      "message": "Customs declaration is not valid for the product or countries combination",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-034",
      "message": "Driver notifies consignee requires recipient number to be present.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-035",
      "message": "A valid mobile phone number or email address is required for Electronic notification to a third party.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-036",
      "message": "Number of items is invalid.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-037",
      "message": "Number of items total is invalid.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-038",
      "message": "Code cannot be empty",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-039",
      "message": "You cannot use loadMeters for this product.",
      "suffixable": false
    },
    {
      "code": "BOOK_VALIDATION-040",
      "message": "A pickup point must be provided for this service.",
      "suffixable": false
    },
    {
      "code": "BOOK-INTERNAL-001",
      "message": "An unexpected error occurred",
      "suffixable": false
    },
    {
      "code": "BOOK-INTERNAL-002",
      "message": "A required external service is unavailable",
      "suffixable": false
    },
    {
      "code": "PICKUP-INTERNAL-001",
      "message": "An unexpected error occurred",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-001",
      "message": "Error with input in pickupOrder",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-002",
      "message": "Postal code must be given and be valid",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-003",
      "message": "Cargo customer must provide cargoInformation element. Parcel customer must provide parcelsInformation element",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-004",
      "message": "This customer number cannot be used to order Pickup",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-005",
      "message": "You must specify pickupIsReadyAtTime element HH:mm:ss",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-006",
      "message": "You must specify pickupDate element yyyy-MM-dd",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-007",
      "message": "Pickup date must be in the future",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-008",
      "message": "weightInGrams is required, and must be an integer larger than zero",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-009",
      "message": "Must be an integer larger than zero",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-010",
      "message": "Country code is required",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-011",
      "message": "Both Pickup Point ID and Country Code is Required",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-012",
      "message": "Selected pickup point should be in recipient country",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-013",
      "message": "Combination pickupIsReadyAtTime and pickupDate must be in the future",
      "suffixable": false
    },
    {
      "code": "PICKUP-INPUT-014",
      "message": "Sender's address is incomplete or invalid and could not be matched",
      "suffixable": false
    },
    {
      "code": "NETS_TRANSACTION_INPUT-001",
      "message": "Missing Nets transaction request",
      "suffixable": false
    },
    {
      "code": "NETS_TRANSACTION_INPUT-002",
      "message": "Missing Nets transaction id",
      "suffixable": false
    },
    {
      "code": "NETS_TRANSACTION_INPUT-003",
      "message": "Missing Bring consignment number",
      "suffixable": false
    },
    {
      "code": "NETS_TRANSACTION_INPUT-004",
      "message": "Missing customer number",
      "suffixable": false
    },
    {
      "code": "SATURDAY_DELIVERY_INPUT-001",
      "message": "Saturday Delivery service not available for given day",
      "suffixable": false
    },
    {
      "code": "SATURDAY_DELIVERY_INPUT-002",
      "message": "Saturday Delivery service not available for given postal codes",
      "suffixable": false
    },
    {
      "code": "SATURDAY_DELIVERY_INPUT-003",
      "message": "Saturday Delivery service not available after 16:00",
      "suffixable": false
    },
    {
      "code": "SATURDAY_DELIVERY_INPUT-004",
      "message": "Saturday Delivery service is available by invoice only",
      "suffixable": false
    },
    {
      "code": "SIMPLIFIED_DELIVERY_INPUT-001",
      "message": "Simplified Delivery service is not applicable with Delivery Options",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-001",
      "message": "Customer specified delivery date must be in the future",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-002",
      "message": "Customer specified delivery date must have valid values and be in format yyyy-MM-ddThh:mm:ss",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-003",
      "message": "Customer specified delivery date can not be null",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-004",
      "message": "Customer specified delivery date is valid for Products: PA_DOREN, 5600 or OIL_EXPRESS",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-005",
      "message": "Customer specified delivery date is not available in expected/alternative delivery dates",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-006",
      "message": "Customer specified delivery date must be after Shipping date",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DISPATCH_DATE-INPUT-001",
      "message": "Customer specified dispatch date must be in the future",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DISPATCH_DATE-INPUT-002",
      "message": "Customer specified dispatch date must have valid values and be in format yyyy-MM-ddThh:mm:ss",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DISPATCH_DATE-INPUT-003",
      "message": "Customer specified dispatch date can not be null",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DISPATCH_DATE-INPUT-004",
      "message": "Customer specified dispatch date is valid for Products: 3622",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DISPATCH_DATE-INPUT-005",
      "message": "Customer specified dispatch date is not available in expected/alternative pickup dates",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DISPATCH_DATE-INPUT-006",
      "message": "Customer specified dispatch date must be after Shipping date",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DISPATCH_DATE-INPUT-007",
      "message": "Customer specified dispatch date can only be requested with 1073 VAS combination",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DELIVERY-INPUT-001",
      "message": "Customer specified delivery is only valid for outgoing home delivery products",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DELIVERY-INPUT-002",
      "message": "StartDateTime and EndDateTime in customerSpecified Delivery needs to be same date",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DELIVERY-INPUT-003",
      "message": "Customer specified delivery start and end date must be in the future",
      "suffixable": false
    },
    {
      "code": "CUSTOMER_SPECIFIED_DELIVERY-INPUT-004",
      "message": "Customer specified delivery dates are not available in expected/alternative delivery dates",
      "suffixable": false
    }
  ]
}

Order a pickup

post
                https://api.bring.com/booking-api/api/pickupOrder
              

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

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
This is deprecated. Use packages and count instead
integer <int32>
numberOfPallets
This is deprecated. Use pallets and count instead
integer <int32>
numberOfPostContainers
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
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
Required
For test bookings, 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
This is deprecated. Use packages and count instead
integer <int32>
numberOfPallets
This is deprecated. Use pallets and count instead
integer <int32>
numberOfPostContainers
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
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
Required
For test bookings, 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>
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>
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>
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>
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": "14:26",
  "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>
  <pickupIsReadyAtTime>14:26</pickupIsReadyAtTime>
  <pickupTimeZone>Europe/Oslo</pickupTimeZone>
  <service>CARGO</service>
</pickupOrderRequest>

Response examples

{
  "pickupConfirmation": {
    "earliestPickupDate": "2022-07-04T22:00:00.000+00:00",
    "latestPickupDate": "2024-03-14T14:25:00.000+00:00",
    "status": "OK"
  }
}
comments powered by Disqus