Booking API
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 make API requests, you will need an API key from Mybring. Steps for getting a key and description of headers can be found on the general API Getting Started / Authentication 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 and SOAP over HTTP. Booking endpoints will assume all requests are UTF-8 encoded.
Versioning
Each request has a schemaVersion
element indicating which release of the schema is being used in the request and expected schema format in the response. Important: All clients must accept new (unknown) elements in the response. E.g. unknown elements should be ignored. The client framework used by client must thus not crash when unknown elements are encountered. Note that this requirement excludes the (old, but still widely used) Apache Axis 1.x Web Service client framework.
Authorization
In addition to authentication, you need to be authorized with the booking right in order to perform bookings. This is done in customer administration in Mybring:
To perform a booking, you must specify which customer number to use. For your convenience, there is an API for getting the customer numbers associated with your API user. The Customer Number API also links customer numbers with the services the customer number is valid for.
Performance
Different service groups have different response times in booking:
- Parcels and courier services
- A booking will typically take < 2 seconds
- Express UPS services and Cargo
- A booking will typically take < 3 seconds
- Express Nordic SameDay
- A booking will typically take < 10 seconds (query in flight schedules). We are working on improving the response times for QuickPack SameDay, making popular city-pairs much faster.
Checking prices and availability
Booking uses Shipping Guide as the source for price and availability for the different services. We advise clients of the Booking API to use Shipping Guide API for getting the list price and checking availability before sending a booking request. Note that invoice payment is the only available payment option for the Booking API. This means that the Mybring user ID used in the booking request must have access to the customer number specified as payer of the booking.
Making labels
The Booking API generates and sends all necessary EDI messages to carry out the shipment. A URL to a PDF label is returned in responses. This label must be printed and be attached to the shipment. A URL that points to tracking information is also returned.
A GET request to the label URL will result in a HTTP 302 redirect to the concrete storage facility (e.g. redirect to Amazon S3). Ensure that your client follows these redirects.
Generating QR Codes
For Parcel Norway domestic return services, it is possible to request QR codes. An end user can bring the QR code to any PiB or a Post Office in Norway, scan the QR code, and have a label printed there.
To book, add the element generateQrCodes
at the consignment level and set it to true
. The response will contain one qrCodeLink
per package. This is a URL to a PNG image of the QR code.
The following services support QR codes:
- 9300
- SERVICEPAKKE_RETURSERVICE
- 9600
- EKSPRESS09_RETURSERVICE
- 9000
- BPAKKE_DOR-DOR_RETURSERVICE
Free return of parcel(s)
For Parcel Norway domestic services, it is possible to book the return shipment at the same time as the outgoing shipment. By setting the element returnProduct
and specifying the return service, you will both get the regular label and the return label in the response.
We recommend to include the return label in the outgoing shipment, so that the return label can easily be used if your customer wants to return the shipment to you.
You will be invoiced for the return only if your customer uses it.
The following outgoing and return service combinations are supported:
Outgoing services | Return services |
---|---|
3570, 3584 |
9650 |
4850, 5000, 5600, 5800 |
9000, 9300, 9600 |
BEDRIFTSPAKKE, SERVICEPAKKE, EKSPRESS09, PA_DOREN |
BPAKKE_DOR-DOR_RETURSERVICE, EKSPRESS09_RETURSERVICE, SERVICEPAKKE_RETURSERVICE |
XML
<returnProduct>
<id>9650</id>
</returnProduct>
JSON
"returnProduct": {
"id": "9650",
}
Mailbox Parcel (Pakke i Postkassen)
- Booking Mailbox Parcel in Booking API is a single-step process with one label per booking (multi-kolli is not supported). Each parcel is invoiced separately. A link to the label is returned in the response.
- When booking Mailbox Parcel in Booking API, the new API customer number is used. This is identical to your company’s main customer number (without prefix PARCELS_NORWAY and without padded zeros if any).
- When booking Mailbox Parcel in Booking API, the service is defined by setting 3584 or 3570 in the product id.
To book, order one of the two product ids:
3570 (tracking with RFID)
Mailbox Parcel shipments can optionally be ordered with tracking using RFID.
Normally, we create PDF labels that can be printed on any printer. If you opt for tracking, we create ZPL labels instead. ZPL stands for Zebra Programming Language (ZPL).
The labels will be ZPL code containing instructions for programming the passive RFID antenna in the printer’s labels with package numbers.
In addition to the RFID programming instructions, the ZPL code contains instructions for rendering the rest of the label (addresses, icons, barcode, etc.).
Special hardware required
RFID-tagged labels require special printer hardware. Currently we support the following printers:
- Zebra R410
- Zebra 500R
3584 (no tracking)
If you don’t have a supported printer, you cannot order shipments with tracking. In this case, we will create normal PDF labels that can be printed using any printer.
Additional Service: Bag on door (Pose på døren)
A delivery alternative for Mailbox Parcels that cannot be delivered to the mailbox.
Mailbox Parcel (Pakke i postkassen) is a parcel that will be delivered in the recipient’s mailbox. If the parcel for various reasons does not fit in the mailbox, the sender may, against a surcharge, choose to leave the parcel on the door handle (in a special bag) to avoid it being sent to the pickup point. It’s recommended that this delivery option is actively confirmed by the receiver upon booking in the sender’s webshop. When the parcel is delivered as a bag on the door, the bar code is scanned and the recipient will receive an SMS/email. Note that if the parcel is delivered in the mailbox the additional fee will not occur.
Terms of delivery
The sender must clearly inform the recipient about the criteria of Bag on door when displaying this service in the check out (e.g. via Shipping Guide API):
- The distance from the mailbox to the recipient’s door must not exceed 250 m
- House no. must be clearly marked
- The door must be clearly marked with the recipient’s name
- Posten must have access to the recipient’s door, even when the main entrance is locked, for instance when recipient live in an apartment.
In cases where the criteria are not met, i.e. bad weather (risk of damage) or where for security reason the risk is considered too high to use Bag on door, the parcel will still be delivered to the recipient’s pickup point for delivery.
Example request
There is an example request for 3584 in “More examples” section below. Booking 3570 is just a matter of changing the service code from 3584 to 3570. If you want to specify a different return address on the label than your actual sender address, use the returnTo party tag. When the returnTo party tag is populated the input will replace your actual sender address on the top left corner of the label.
Customs Export information
It is required to pass customs information when booking the following services from Norway -> abroad:
- Business Parcel
- PickUp Parcel
Sending customs information as part of a booking request only applies to the aforementioned products.
When included during booking, the customs information will be sent electronically from Bring to the destination country.
If sending customs information, the following elements are to be used:
- quantity (required)
- goodsDescription (required)
- customsArticleNumber (optional)
- itemNetWeightInKg (required)
- tarriffLineAmount (required)
- currency (required)
- countryOfOrigin (required)
- natureOfTransaction (required)
Please refer to the Request params section below for more details about the elements. Customs tariff codes (tolltariffnummer).
Example
In this example, you are sending a parcel/shipment with 2 shampoos, 5 cotton t-shirts and 1 wool jacket. The number of pieces is 8 (2 shampoos + 5 cotton t-shirts + 1 wool jacket), and the number of articles is 3 (shampoo, cotton t-shirt, wool jacket). The whole shipment is referred to as an item.
Quantity | Description of contents | Customs tariff code | Total content net weight (kg) | Total content value | Currency | Country of origin |
---|---|---|---|---|---|---|
2 |
shampoo |
33.05.1000 |
3.0 |
200 |
NOK |
CH |
5 |
cotton t-shirts |
61.09.1000 |
2.5 |
1000 |
NOK |
PL |
1 |
wool jacket |
61.04.3100 |
2.0 |
750 |
NOK |
DE |
Nature of Transaction: Gift or Sale of Goods or Returned Goods or Commercial Sample or Documents or Other
Sending Importer
party in the request is not mandatory. But if there is no importer sent then system will consider recipient as importer.
Another additional field captured for customs is vatNumber
for the parties. This is an optional field. If you are setting importer party then you can add vatNumber
in it,
else you can set vatNumber
in the existing recipient party.
There are two examples in the More Examples section below that show requests containing customs information.
- In one of these examples, importer not sent in request, hence the recipient is the importing party with (optional)
vatNumber
. - In the other example, there is importer party set in the request with the (optional)
vatNumber
.
IOSS (Import One-Stop Shop) - Adding an IOSS number for exports from Norway to EU
By using the iossNumber
element of ediCustomsDeclarations
, one can specify an IOSS number for exports from Norway to EU countries. Only applicable when natureOfTransaction
is of type SALE_OF_GOODS
.
Note that this can not be combined with a reference
field on the senders
party. More info on IOSS.
LQ - Limited quantities (of dangerous goods)
When booking Nordic parcel services it is possible to specify that a shipment contains limited quantities of dangerous goods, by adding the 0003
additional service.
The LQ gross weight is optional unless the shipment is transported by boat, as specified in the table below:
From | To |
---|---|
ALL except FI | FI, FO, GL, IS, AX |
FI | SE, DK, NO, FO, GL, IS, AX |
In such cases the gross weight of Limited quantities must be provided. The document Multimodal Dangerous Goods Form must also be completed correctly and sent to Bring’s booking department before transportation begins.
The following rules apply:
- The document Multimodal Dangerous Goods Form must also be completed correctly and sent to Bring’s booking department before transportation begins
- For shipments with LQ transported by boat (see table above), it is mandatory to specify the LQ gross weight and a dangerous goods declaration must be attached physically to the parcel/pallet.
- For shipments with LQ to NO, DK or FI, it’s not allowed to send shipments with LQ to islands without bridge connections.
- For shipments with LQ to SE: except from Gotland, it’s not allowed to send shipments with LQ to islands without bridge connections. For such shipments to Gotland, it is always mandatory to specify the LQ gross weight in grams.
Subscribe to updates
Endpoints
https://api.bring.com/booking/api
Usage | Method | Endpoint |
---|---|---|
List customer numbers and services | GET |
/customers
|
Make a booking | POST |
/booking
|
Error codes | GET |
/errors
|
Order a pickup | POST |
/pickupOrder
|
Get expected delivery, service categories and additional information. | POST |
/ws
|
List customer numbers
https://api.bring.com/booking/api/customers
The customer numbers are prefixed with the specialist, followed by the number. For Courier and Bring Express-services, we use a UUID to identify users.
The customer API will return for each specialist a list with the services that you can order through the booking API.
Specialist | Example services | Example customer number |
---|---|---|
Bring Parcels, Norway | BPAKKE_DOR-DOR , PA_DOREN , EKSPRESS09 , 3584 |
5 |
Bring Cargo, Norway | CARGO_GROUPAGE |
7 |
Bring Cargo, International | CARGO_INTERNATIONAL |
CARGO-803739 |
Bring Express, Norway | COURIER_4H , EXPRESS_NORDIC_SAME_DAY , EXPRESS_INTERNATIONAL |
EXPRESS_NORWAY-2caedf20-27da-012f-3858-58b0357c4f66 |
Bring Express, Sweden | COURIER_4H , EXPRESS_NORDIC_SAME_DAY , EXPRESS_INTERNATIONAL |
EXPRESS_SWEDEN-406077f0-27da-012f-3859-58b0357c4f66 |
Oil Express, Norway | OIL_EXPRESS |
SYSPED_NORWAY-12345 |
List of services for each customer type
Request parameters
HTTP header | Type | Description |
---|---|---|
Accept |
application/json or application/xml |
Required |
Responses
HTTP status code 200
Media type: application/json
{
"customers": [
{
"name": "Demo Parcel Nordic Converted Customer (00000000006)",
"customerNumber": "6",
"countryCode": "NO",
"products": [
"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"
]
},
{
"name": "Demo Parcel Nordic Converted Customer (000006)",
"customerNumber": "6",
"countryCode": "DK",
"products": [
"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"
]
},
{
"name": "Demo Parcel Nordic Converted Customer (000006)",
"customerNumber": "6",
"countryCode": "FI",
"products": [
"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"
]
},
{
"name": "Demo Parcel Nordic Converted Customer (000006)",
"customerNumber": "6",
"countryCode": "NO",
"products": [
"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"
]
},
{
"name": "Demo Parcel Nordic Converted Customer (000006)",
"customerNumber": "6",
"countryCode": "SE",
"products": [
"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"
]
},
{
"name": "Demo Parcel Nordic Converted Customer (6)",
"customerNumber": "6",
"countryCode": "DK",
"products": [
"0345"
]
},
{
"name": "Demo Parcel Nordic Converted Customer (6)",
"customerNumber": "6",
"countryCode": "FI",
"products": [
"0345"
]
},
{
"name": "Demo Parcel Nordic Converted Customer (6)",
"customerNumber": "6",
"countryCode": "NO",
"products": [
"3570",
"3584",
"4850",
"5000",
"5600",
"5800",
"9000",
"9300",
"9600",
"9650"
]
},
{
"name": "Demo Parcel Nordic Converted Customer (6)",
"customerNumber": "6",
"countryCode": "SE",
"products": [
"0345"
]
}
]
}
Media type: application/xml
<customersResponse xmlns="http://www.bring.no/booking/">
<customers>
<customer>
<name>Demo Parcel Nordic Converted Customer (6)</name>
<customerNumber>6</customerNumber>
<countryCode>DK</countryCode>
<products>
<product>0345</product>
<product>BUSINESS_HALFPALLET</product>
<product>BUSINESS_PALLET</product>
<product>BUSINESS_PARCEL</product>
<product>BUSINESS_PARCEL_BULK</product>
<product>BUSINESS_QUARTERPALLET</product>
<product>EXPRESS_NORDIC_0900</product>
<product>EXPRESS_NORDIC_0900_BULK</product>
<product>HOME_DELIVERY_PARCEL</product>
<product>PICKUP_PARCEL</product>
<product>PICKUP_PARCEL_BULK</product>
</products>
</customer>
<customer>
<name>Demo Parcel Nordic Converted Customer (6)</name>
<customerNumber>6</customerNumber>
<countryCode>FI</countryCode>
<products>
<product>0345</product>
<product>BUSINESS_HALFPALLET</product>
<product>BUSINESS_PALLET</product>
<product>BUSINESS_PARCEL</product>
<product>BUSINESS_PARCEL_BULK</product>
<product>BUSINESS_QUARTERPALLET</product>
<product>EXPRESS_NORDIC_0900</product>
<product>EXPRESS_NORDIC_0900_BULK</product>
<product>HOME_DELIVERY_PARCEL</product>
<product>PICKUP_PARCEL</product>
<product>PICKUP_PARCEL_BULK</product>
</products>
</customer>
<customer>
<name>Demo Parcel Nordic Converted Customer (6)</name>
<customerNumber>6</customerNumber>
<countryCode>NO</countryCode>
<products>
<product>3570</product>
<product>3584</product>
<product>4850</product>
<product>5000</product>
<product>5100</product>
<product>5300</product>
<product>5400</product>
<product>5600</product>
<product>5800</product>
<product>9000</product>
<product>9100</product>
<product>9300</product>
<product>9600</product>
<product>9650</product>
<product>BUSINESS_HALFPALLET</product>
<product>BUSINESS_PALLET</product>
<product>BUSINESS_PARCEL</product>
<product>BUSINESS_PARCEL_BULK</product>
<product>BUSINESS_QUARTERPALLET</product>
<product>EXPRESS_NORDIC_0900</product>
<product>EXPRESS_NORDIC_0900_BULK</product>
<product>HOME_DELIVERY_PARCEL</product>
<product>PICKUP_PARCEL</product>
<product>PICKUP_PARCEL_BULK</product>
</products>
</customer>
<customer>
<name>Demo Parcel Nordic Converted Customer (6)</name>
<customerNumber>6</customerNumber>
<countryCode>SE</countryCode>
<products>
<product>0345</product>
<product>BUSINESS_HALFPALLET</product>
<product>BUSINESS_PALLET</product>
<product>BUSINESS_PARCEL</product>
<product>BUSINESS_PARCEL_BULK</product>
<product>BUSINESS_QUARTERPALLET</product>
<product>EXPRESS_NORDIC_0900</product>
<product>EXPRESS_NORDIC_0900_BULK</product>
<product>HOME_DELIVERY_PARCEL</product>
<product>PICKUP_PARCEL</product>
<product>PICKUP_PARCEL_BULK</product>
</products>
</customer>
</customers>
</customersResponse>
Book shipments
https://api.bring.com/booking/api/booking
This is the endpoint where you can book a shipment and get a printable label in return.
Value added services
The following services have available value added services:
Services | Value added services |
---|---|
SERVICEPAKKE | POSTOPPKRAV, EVARSLING |
BPAKKE_DOR-DOR | EVARSLING, SIMPLE_DELIVERY, deliveryOption |
PA_DOREN | EVARSLING, SIMPLE_DELIVERY, deliveryOption |
EKSPRESS09 | EVARSLING, LORDAGSUTKJORING |
3570 | 1081 |
3584 | 1081 |
See the “More examples” section below to see examples on how to use value added services.
You have to send a list of additionalService tags under the additionalServices tag, where the id element identify the additional service to request.
XML
<additionalServices>
<additionalService>
<id>EVARSLING</id>
<email>sender@sender.com</email>
<mobile>12345</mobile>
</additionalService>
<additionalService>
<id>DANGEROUS_GOODS</id>
<mobile>777777</mobile>
<unNumber>ABC</unNumber>
</additionalService>
</additionalServices>
JSON
"additionalServices": [
{
"id": "DANGEROUS_GOODS",
"unNumber": "ABC"
},
{
"id": "EVARSLING",
"email": "recipient@recipient.com",
"mobile": "97777777"
}
]
Error handling
If an error occurs, the following will be provided:
uniqueId
: A unique log ID (UUID) that can be used as a reference for the errorcode
: An error code describing the errormessage
: Internationalized messages (with<message lang="xx">
elements). First version will be withlang="en"
(English) only.
See the error codes below to get an overview of error codes and what they mean.
Testing
This service will send actual production orders unless it is set to testing mode.
To use the test mode, you need to set the testIndicator
flag to true
on the root node.
Note that this test mode exists only for development purposes, not production use. It is rate limited, and may therefore affect your performance if used in production.
Note that the examples below use testIndicator=true
, so remove this when implementing the Booking API in your production system.
Measurements
For cargo services(5100, 5300, CARGO, 9100), Weight is mandatory and one of the Volume / Load Meter / Dimensions / Number of Pallets is mandatory.
For home delivery services (DOUBLE_INDOOR, CURBSIDE, DOUBLE_INDOOR_EVENING, CURBSIDE_EVENING), Weight is mandatory and one of Volume / Dimensions are mandatory.
Request parameters
HTTP header | Type | Description |
---|---|---|
Accept |
string |
Optional
Specify response format (application/json, application/xml) Possible values:
Default value: same as Content-Type |
Content-Type |
string |
Required
Specify request format (application/json, application/xml) Possible values:
|
Query param | Type | Description |
---|---|---|
accountNumber |
string |
Required
Specify account number for cash on delivery. This parameter can be maximum 35 character long. Example: 12345678903 |
accountType |
string |
Required
Specify account type. This parameter can be maximum 35 character long. Possible values:
|
additionalAddressInfo |
string |
Optional Pickup instruction and delivery instruction for use on labels (and any waybills) 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). This parameter can be maximum 70 character long. |
addressLine |
string |
Required
Specify address. This parameter can be maximum 35 character long. Example: Testsvingen 12 |
addressLine2 |
string |
Required Specify address line 2. This parameter can be 35 character long. |
amount |
double |
Required Specify amount |
city |
string |
Required Specify the city. This parameter can be maximum 35 character long. |
commodity |
string |
Required
Specify name of the dangerous good. This parameter can be maximum 35 character long. Example: ARSENTRIKLORID |
contact |
string |
Optional
Specify contact details - name, email and phoneNumber in the child tags. Example: check the example request to see how contact block is build |
containerId |
string |
Required
Specify the container identification in which dangerous good is packed. This parameter can be maximum 35 character long. Example: 1236 |
correlationId |
string |
Required Specify something to correlate packages which belong to same order |
countryCode |
string |
Required
Specify the country code. This parameter must be 2 characters long. Example: NO |
countryOfOrigin |
string |
Optional
The country code of origin of the articles in an ediCustomsDeclaration line. This parameter must be 2 characters long.Example: SE |
currency |
string |
Required
The currency code used in an ediCustomsDeclaration line. This parameter must be 3 characters long.Example: SEK |
currencyCode |
string |
Required
Specify currency code Example: NOK |
customerNumber |
string |
Required
Specify API customer number. This parameter can be maximum 35 character long. Example: PARCELS_NORWAY-*********, 6 |
customerSpecifiedDeliveryDateTime |
dateTime |
Optional
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 ‘PA_DOREN’, ‘5600’, and ‘OIL_EXPRESS’. For ‘PA_DOREN’ and ‘5600’ the date cannot cannot be set to more than current date + 10 days. Example: 2020-05-11T11:12:13 (yyyy-MM-ddThh:mm:ss) |
customsArticleNumber |
string |
Optional
The customs article number in an ediCustomsDeclaration lineExample: 33.05.1000 |
dangerClass |
string |
Required
Specify the class of dangerous good. This parameter can be maximum 35 character long. Example: 1 |
email |
string |
Required
Specify e-mail address if you want booking confirmation e-mail to be sent. Can be applied to sender’s e-mail (outgoing services) and sender’s e-mail/recipient’s e-mail (return services) . This parameter can be maximum 60 character long. Pattern: ^((\w*_)?(p|m|)\d*(\.\d|)|(\w*_)?(p|m)\d*(\.\d|)p)$ |
generateQrCodes |
boolean |
Optional Specify whether QR codes is wanted in addition to the regular label for certain services. See the qr-codes section for more on this. |
goodsDescription |
string |
Required
This can be used in three different elements; package (optional), packageGroup (optional), and ediCustomsDeclaration (required). It describes what is inside the package. This parameter can be maximum 35 characters long. |
heightInCm |
integer |
Required
Specify height in cm. Dimension is optional when volumeInDm3 is specified in the request for cargo. Example: 100 |
iossNumber |
string |
Optional
Import One-Stop Shop (IOSS) number used for customs export from Norway to EU. This field is optional when customs export information in the request. It must be on the form 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. |
itemNetWeightInKg |
double |
Required
The weight (in kg) of all the articles declared in an ediCustomsDeclaration line |
lengthInCm |
integer |
Required
Specify length in cm. Dimension is optional when volumeInDm3 is specified in the request for cargo. Example: 100 |
loadMeters |
double |
Optional
Specify Load meters when request is for Cargo. Maximum value is 49.9 Example: 2.0 |
messageForRecipient |
string |
Required Specify message to recipient. This parameter can be maximum 35 character long. |
natureOfTransaction |
string |
Required
Specifies the purpose of transaction. This field is mandatory when sending customs information in the request. Possible values:
|
nonStandardCourierProductCode |
string |
Optional
Specify the product code for customize courier services. This field is mandatory when request is for Non Standard Courier. Example: CDA |
numberOfItems |
integer |
Required
Specify number of items within a package Example: 5 |
numberOfPallets |
integer |
Optional
Specify Number of pallets when request is for Cargo Example: 3 |
packages |
object |
Required A list of the packages included in the consignment. Limited to 50 packages. |
phoneNumber |
string |
Required
Specify phone number. Note Sender Phone number is a mandatory field for all outgoing services. Exceptions to this rule are 3584, 3570 and all the return services in mybring. |
postalCode |
string |
Required Specify the postal code. This parameter can be maximum 35 character long. |
purchaseOrderNumber |
string |
Required Specify when there is any purchase orders associated with the booking. This parameter can be maximum 35 character long. |
quantity |
integer |
Required
The number of articles in an ediCustomsDeclaration line |
reference |
string |
Required Specify shipper or consignee reference. This parameter can be maximum 35 character long. |
returnProduct |
boolean |
Optional Specify the return service which should be used to generate a return shipment along with outgoing shipment. See the return product section for more on this. |
schemaVersion |
integer |
Required
Currently, it is 1 Example: 1 |
shippingDateTime |
dateTime |
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. Example: 2016-07-26T06:24:09 or 1469494449000 (milliseconds since 01.01.1970, for json req) |
tarriffLineAmount |
double |
Required
The value of all the articles declared in an ediCustomsDeclaration line |
testIndicator |
boolean |
Required It is true for test orders. |
unNumber |
string |
Required
Specify UN number of dangerous good. This parameter can be maximum 35 character long. Example: 1560 |
vatNumber |
string |
Required Specify organisation number. This parameter can be maximum 30 character long. |
volumeInDm3 |
decimal |
Required Specify volume in cubic decimeter. This is optional when dimension is specified in the request for cargo. |
weightInKg |
double |
Required
Specify weight in kilograms Example: 15.2 |
whoPaysInvoice |
string |
Required
Specify which party will pay the invoice for the booking. This parameter can be maximum 35 character long. Possible values:
|
widthInCm |
integer |
Required
Specify width in cm. Dimension is optional when volumeInDm3 is specified in the request for cargo. Example: 100 |
Request body
Media type: application/json
{
"testIndicator": true,
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": "2020-05-05T10:00:00",
"customerSpecifiedDeliveryDateTime": "2020-05-11T10:00:00",
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "no",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "no",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "88888888"
}
},
"pickupPoint": null
},
"product": {
"id": "5600",
"customerNumber": "5",
"additionalServices": [
{
"id": "EVARSLING",
"email": "recipient@recipient.com",
"mobile": "97777777"
}
]
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
]
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2020-05-05T21:31:33.007+02:00</shippingDateTime>
<customerSpecifiedDeliveryDateTime>2020-05-11T00:00:00</customerSpecifiedDeliveryDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>0263</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden etter klokken to</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email>trond@nordmanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>0659</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>5600</id>
<customerNumber>5</customerNumber>
<additionalServices>
<additionalService>
<id>EVARSLING</id>
<email>sender@sender.com</email>
<mobile>12345</mobile>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>1.1</weightInKg>
<goodsDescription>Testing equipment</goodsDescription>
<dimensions>
<heightInCm>13</heightInCm>
<widthInCm>23</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
Responses
HTTP status code 200
On a successful request, the response gives information about the booking. Most importantly it contains a link to the label for the shipment.
Media type: application/json
{
"consignments": [
{
"confirmation": {
"consignmentNumber": "70438101268018539",
"productSpecificData": null,
"links": {
"labels": "https://api.bring.com/labels/id/6d8c4323-87cd-47e8-aa0d-75f8f0b5b4cb.pdf",
"waybill": null,
"tracking": "https://sporing.bring.no/sporing.html?q=70438101268018539"
},
"dateAndTimes": {
"earliestPickup": null,
"expectedDelivery": 1436295739676
},
"packages": [
{
"packageNumber": "370438101268058536",
"correlationId": "PACKAGE-123"
}
]
},
"errors": null,
"correlationId": "INTERNAL-123456"
}
]
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bookingResponse xmlns="http://www.bring.no/booking/">
<consignments>
<consignment correlationId="INTERNAL-123456">
<confirmation>
<consignmentNumber>70438101268018539</consignmentNumber>
<links>
<labels>https://api.bring.com/labels/id/6d8c4323-87cd-47e8-aa0d-75f8f0b5b4cb.pdf</labels>
<tracking>https://sporing.bring.no/sporing.html?q=70438101268018539</tracking>
</links>
<dateAndTimes>
<expectedDelivery>2020-05-13T21:33:10.900+02:00</expectedDelivery>
</dateAndTimes>
<packages>
<package correlationId="PACKAGE-123">
<packageNumber>370438101268058536</packageNumber>
</package>
</packages>
</confirmation>
</consignment>
</consignments>
</bookingResponse>
The recipientNotification
attribute/element must be set for all services that allow electronic notification, in order for the recipient to receive electronic notification. This element must the recipient’s mobile phone number and/or e-mail address.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": 1447424420243,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes p\u00e5 baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c\/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": null
},
"product": {
"id": "SERVICEPAKKE",
"customerNumber": "**************",
"additionalServices": [
{
"id": "EVARSLING",
"email": "recipient@recipient.com",
"mobile": "97777777"
}
],
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2015-11-13T15:25:22.346+01:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>0263</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden etter klokken to</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email>trond@nordmanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>0659</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>+46700000000</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>SERVICEPAKKE</id>
<customerNumber>**************</customerNumber>
<additionalServices>
<additionalService>
<id>EVARSLING</id>
<email>sender@sender.com</email>
<mobile>777777</mobile>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>1.1</weightInKg>
<goodsDescription>Testing equipment</goodsDescription>
<dimensions>
<heightInCm>13</heightInCm>
<widthInCm>23</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The cashOnDelivery
element/attribute can be set for services that allow cash on delivery. This element must contain the account number, the amount, the currency code and a kid
, which is a customer identification number.
Amount
field only accepts numeric values without comma in it and with two decimal places.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": 1447751168645,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": null
},
"product": {
"id": "SERVICEPAKKE",
"customerNumber": "*************",
"additionalServices": [
{
"id": "POSTOPPKRAV",
"accountNumber": "12345678903",
"accountType": null,
"amount": 1000,
"currencyCode": "NOK",
"codMessage": {
"value": "A valid customer identification number",
"type": "kid"
}
}
],
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>
1
</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>
2015-11-17T10:06:08.541+01:00
</shippingDateTime>
<parties>
<sender>
<name>
Ola Nordmann
</name>
<addressLine>
Testsvingen 12
</addressLine>
<postalCode>
0263
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
1234
</reference>
<additionalAddressInfo>
Hentes på baksiden etter klokken to
</additionalAddressInfo>
<contact>
<name>
Trond Nordmann
</name>
<email>
trond@nordmanntest.no
</email>
<phoneNumber>
99999999
</phoneNumber>
</contact>
</sender>
<recipient>
<name>
Tore Mottaker
</name>
<addressLine>
Mottakerveien 14
</addressLine>
<addressLine2>
c/o Tina Mottaker
</addressLine2>
<postalCode>
0659
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
43242
</reference>
<additionalAddressInfo>
Bruk ringeklokken
</additionalAddressInfo>
<contact>
<name>
Tore mottaker
</name>
<email>
tore@mottakertest.no
</email>
<phoneNumber>
+46700000000
</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>
SERVICEPAKKE
</id>
<customerNumber>
*************
</customerNumber>
<additionalServices>
<additionalService>
<id>POSTOPPKRAV</id>
<accountNumber>
12345678903
</accountNumber>
<amount>
1000.0
</amount>
<currencyCode>
NOK
</currencyCode>
<codMessage>
<value>A valid customer identification number</value>
<type>kid</type>
</codMessage>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>
1.1
</weightInKg>
<goodsDescription>
Testing equipment
</goodsDescription>
<dimensions>
<heightInCm>
13
</heightInCm>
<widthInCm>
23
</widthInCm>
<lengthInCm>
10
</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The quickPackEnvelope
element/attribute is of type boolean, and can be set for services that allow quickpack envelope shipment. We recommend using the weight and measurements shown in the example, for correct mapping.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": 1447751168650,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": null
},
"product": {
"id": "EXPRESS_INTERNATIONAL",
"customerNumber": "*************",
"additionalServices": [
{
"id": "ENVELOPE"
}
],
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 2,
"widthInCm": 35,
"lengthInCm": 24
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": null
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>
1
</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>
2015-11-17T10:06:08.543+01:00
</shippingDateTime>
<parties>
<sender>
<name>
Ola Nordmann
</name>
<addressLine>
Testsvingen 12
</addressLine>
<postalCode>
0263
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
1234
</reference>
<additionalAddressInfo>
Hentes på baksiden etter klokken to
</additionalAddressInfo>
<contact>
<name>
Trond Nordmann
</name>
<email>
trond@nordmanntest.no
</email>
<phoneNumber>
99999999
</phoneNumber>
</contact>
</sender>
<recipient>
<name>
Tore Mottaker
</name>
<addressLine>
Mottakerveien 14
</addressLine>
<addressLine2>
c/o Tina Mottaker
</addressLine2>
<postalCode>
0659
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
43242
</reference>
<additionalAddressInfo>
Bruk ringeklokken
</additionalAddressInfo>
<contact>
<name>
Tore mottaker
</name>
<email>
tore@mottakertest.no
</email>
<phoneNumber>
+46700000000
</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>
EXPRESS_INTERNATIONAL
</id>
<customerNumber>
***************
</customerNumber>
<additionalServices>
<additionalService>
<id>ENVELOPE</id>
</additionalService>
</additionalServices>
</product>
<packages>
<package>
<weightInKg>
1.0
</weightInKg>
<goodsDescription>
Testing equipment
</goodsDescription>
<dimensions>
<heightInCm>
2
</heightInCm>
<widthInCm>
35
</widthInCm>
<lengthInCm>
24
</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
Attempted delivery
If a sender want their package delivered to the door, and it cannot be delivered (i.e. Business closed or recipient is not present), then you can now choose what will happen with your package.
If you want Bring to try deliver only once and/or deliver package to nearest PiB, then you must tell us by setting this option. These options cost extra money but the customer/sender will only be charged if the event happen.
Example:
You send a package to a business with the deliveryOption=TWO_DELIVERIES_THEN_PIB
.
- If Bring manage to deliver the package to the recipient on first try, then no extra charges is made.
- If first attempt to deliver fails, then Bring will do a second attempt. The customer/sender will be charged extra.
- If the second attempt also fails, then the package will be delivered to nearest PiB. The customer/sender will be charged extra.
Possible options:
ONE_DELIVERY_THEN_PIB
TWO_DELIVERIES_THEN_PIB
TWO_DELIVERIES_THEN_RETURN
Media type: application/json
{
"schemaVersion": null,
"consignments": [
{
"shippingDateTime": 1447751818780,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": null
},
"product": {
"id": "BPAKKE_DOR-DOR",
"customerNumber": "**********",
"services": {
"deliveryOption": "TWO_DELIVERIES_THEN_PIB",
},
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456"
}
],
"testIndicator": null
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="null">
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>
2015-11-17T10:06:08.563+01:00
</shippingDateTime>
<parties>
<sender>
<name>
Ola Nordmann
</name>
<addressLine>
Testsvingen 12
</addressLine>
<postalCode>
0263
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
1234
</reference>
<additionalAddressInfo>
Hentes på baksiden etter klokken to
</additionalAddressInfo>
<contact>
<name>
Trond Nordmann
</name>
<email>
trond@nordmanntest.no
</email>
<phoneNumber>
99999999
</phoneNumber>
</contact>
</sender>
<recipient>
<name>
Tore Mottaker
</name>
<addressLine>
Mottakerveien 14
</addressLine>
<addressLine2>
c/o Tina Mottaker
</addressLine2>
<postalCode>
0659
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
43242
</reference>
<additionalAddressInfo>
Bruk ringeklokken
</additionalAddressInfo>
<contact>
<name>
Tore mottaker
</name>
<email>
tore@mottakertest.no
</email>
<phoneNumber>
+46700000000
</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>
BPAKKE_DOR-DOR
</id>
<customerNumber>
***************
</customerNumber>
<services>
<deliveryOption>
TWO_DELIVERIES_THEN_PIB
</deliveryOption>
</services>
</product>
</consignment>
</consignments>
</bookingRequest>
The flexDelivery
element/attribute can be set for services that allow flex delivery. This element must contain an instruction message for the driver.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": 1447751818783,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": null
},
"product": {
"id": "BUSINESS_PARCEL",
"customerNumber": "*************",
"additionalServices": [
{
"id": "FLEX_DELIVERY",
"message" : "Legg pakken i garasje"
}
],
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>
1
</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>
2015-11-17T10:06:08.571+01:00
</shippingDateTime>
<parties>
<sender>
<name>
Ola Nordmann
</name>
<addressLine>
Testsvingen 12
</addressLine>
<postalCode>
0263
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
1234
</reference>
<additionalAddressInfo>
Hentes på baksiden etter klokken to
</additionalAddressInfo>
<contact>
<name>
Trond Nordmann
</name>
<email>
trond@nordmanntest.no
</email>
<phoneNumber>
99999999
</phoneNumber>
</contact>
</sender>
<recipient>
<name>
Tore Mottaker
</name>
<addressLine>
Mottakerveien 14
</addressLine>
<addressLine2>
c/o Tina Mottaker
</addressLine2>
<postalCode>
0659
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
43242
</reference>
<additionalAddressInfo>
Bruk ringeklokken
</additionalAddressInfo>
<contact>
<name>
Tore mottaker
</name>
<email>
tore@mottakertest.no
</email>
<phoneNumber>
+46700000000
</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>
BUSINESS_PARCEL
</id>
<customerNumber>
************
</customerNumber>
<additionalServices>
<additionalService>
<id>FLEX_DELIVERY</id>
<message>Legg pakken i garasjen.</message>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>
1.1
</weightInKg>
<goodsDescription>
Testing equipment
</goodsDescription>
<dimensions>
<heightInCm>
13
</heightInCm>
<widthInCm>
23
</widthInCm>
<lengthInCm>
10
</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
You can specify pickup point Id in request for SERVICEPAKKE
and PICKUP_PARCEL_BULK
services for delivery of parcels within Norway and to Norway from other countries. Use Pickup Point API to get list of nearest pickup points.
The parcel will be delivered to the pickup point specified in the request with SMS/Email notification. Pickup point delivery requires that the recipient has email and/or phone number set, so that he can receive notification when the package arrives at the pickup point.
Pickup point id and country code has to be specified under pickupPoint
within parties
as shown below.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": 1447751818806,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": {
"id": "736431",
"countryCode": "NO"
}
},
"product": {
"id": "SERVICEPAKKE",
"customerNumber": "**********",
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>
1
</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>
2015-11-17T10:06:08.556+01:00
</shippingDateTime>
<parties>
<sender>
<name>
Ola Nordmann
</name>
<addressLine>
Testsvingen 12
</addressLine>
<postalCode>
0263
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
1234
</reference>
<additionalAddressInfo>
Hentes på baksiden etter klokken to
</additionalAddressInfo>
<contact>
<name>
Trond Nordmann
</name>
<email>
trond@nordmanntest.no
</email>
<phoneNumber>
99999999
</phoneNumber>
</contact>
</sender>
<recipient>
<name>
Tore Mottaker
</name>
<addressLine>
Mottakerveien 14
</addressLine>
<addressLine2>
c/o Tina Mottaker
</addressLine2>
<postalCode>
0659
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
43242
</reference>
<additionalAddressInfo>
Bruk ringeklokken
</additionalAddressInfo>
<contact>
<name>
Tore mottaker
</name>
<email>
tore@mottakertest.no
</email>
<phoneNumber>
+46700000000
</phoneNumber>
</contact>
</recipient>
<pickupPoint>
<id>
736431
</id>
<countryCode>
NO
</countryCode>
</pickupPoint>
</parties>
<product>
<id>
SERVICEPAKKE
</id>
<customerNumber>
**************
</customerNumber>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>
1.1
</weightInKg>
<goodsDescription>
Testing equipment
</goodsDescription>
<dimensions>
<heightInCm>
13
</heightInCm>
<widthInCm>
23
</widthInCm>
<lengthInCm>
10
</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
You can specify pickup point Id in request for PICKUP_PARCEL_BULK
services for delivery of parcels within Sweden and to Sweden from other countries. Use Pickup Point API to get list of nearest pickup points.
The parcel will be delivered to the pickup point specified in the request with SMS/Email notification. Pickup point delivery requires that the recipient has email and/or phone number set, so that he can receive notification when the package arrives at the pickup point.
Pickup point id and country code has to be specified under pickupPoint
in parties
as shown below.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": 1448632597111,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "12000",
"city": "Stockholm",
"countryCode": "SE",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "41100",
"city": "Göteborg",
"countryCode": "SE",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": {
"id": "736431",
"countryCode": "SE"
}
},
"product": {
"id": "PICKUP_PARCEL_BULK",
"customerNumber": "6",
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>
1
</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>
2015-11-27T14:56:43.392+01:00
</shippingDateTime>
<parties>
<sender>
<name>
Ola Nordmann
</name>
<addressLine>
Testsvingen 12
</addressLine>
<postalCode>
2000
</postalCode>
<city>
Fredriksberg
</city>
<countryCode>
DK
</countryCode>
<reference>
1234
</reference>
<additionalAddressInfo>
Hentes på baksiden etter klokken to
</additionalAddressInfo>
<contact>
<name>
Trond Nordmann
</name>
<email>
trond@nordmanntest.no
</email>
<phoneNumber>
99999999
</phoneNumber>
</contact>
</sender>
<recipient>
<name>
Tore Mottaker
</name>
<addressLine>
Mottakerveien 14
</addressLine>
<addressLine2>
c/o Tina Mottaker
</addressLine2>
<postalCode>
2600
</postalCode>
<city>
Glostrup
</city>
<countryCode>
DK
</countryCode>
<reference>
43242
</reference>
<additionalAddressInfo>
Bruk ringeklokken
</additionalAddressInfo>
<contact>
<name>
Tore mottaker
</name>
<email>
tore@mottakertest.no
</email>
<phoneNumber>
+46700000000
</phoneNumber>
</contact>
</recipient>
<pickupPoint>
<id>
736431
</id>
<countryCode>
DK
</countryCode>
</pickupPoint>
</parties>
<product>
<id>
PICKUP_PARCEL
</id>
<customerNumber>
6
</customerNumber>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>
1.1
</weightInKg>
<goodsDescription>
Testing equipment
</goodsDescription>
<dimensions>
<heightInCm>
13
</heightInCm>
<widthInCm>
23
</widthInCm>
<lengthInCm>
10
</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The services PICKUP_PARCEL
and PICKUP_PARCEL_BULK
support the deliveryOption=PICKUP_POINT
for shipments within Denmark and to Denmark, respectively. The parcel will be delivered to the pickup point closest to the recipient address and the recipient will receive a notification when the parcel arrives. If you do not specify a delivery option for these services in Denmark, the package will be delivered to the door.
You can also specify a pickup point id to get the package delivered at a specific pickup point. Use Pickup Point API to get list of nearest pickup points. Pickup point id and country code has to be specified under pickupPoint
within parties
as shown below.
pickupPoint
is optional but both id
and countryCode
inside it are mandatory. This element has precedence over deliveryOption=PICKUP_POINT
i.e. if this element is present then pickup point specified in it will be selected irrespective of value set in deliveryOption
.
Pickup point delivery requires that the recipient has email and/or phone number set, so that he can receive notification when the package arrives at the pickup point.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": 1448632597117,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "2000",
"city": "Fredriksberg",
"countryCode": "DK",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "2600",
"city": "Glostrup",
"countryCode": "DK",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": {
"id": "736431",
"countryCode": "DK"
}
},
"product": {
"id": "PICKUP_PARCEL",
"customerNumber": "6",
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>
1
</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>
2015-11-27T14:56:43.392+01:00
</shippingDateTime>
<parties>
<sender>
<name>
Ola Nordmann
</name>
<addressLine>
Testsvingen 12
</addressLine>
<postalCode>
2000
</postalCode>
<city>
Fredriksberg
</city>
<countryCode>
DK
</countryCode>
<reference>
1234
</reference>
<additionalAddressInfo>
Hentes på baksiden etter klokken to
</additionalAddressInfo>
<contact>
<name>
Trond Nordmann
</name>
<email>
trond@nordmanntest.no
</email>
<phoneNumber>
99999999
</phoneNumber>
</contact>
</sender>
<recipient>
<name>
Tore Mottaker
</name>
<addressLine>
Mottakerveien 14
</addressLine>
<addressLine2>
c/o Tina Mottaker
</addressLine2>
<postalCode>
2600
</postalCode>
<city>
Glostrup
</city>
<countryCode>
DK
</countryCode>
<reference>
43242
</reference>
<additionalAddressInfo>
Bruk ringeklokken
</additionalAddressInfo>
<contact>
<name>
Tore mottaker
</name>
<email>
tore@mottakertest.no
</email>
<phoneNumber>
+46700000000
</phoneNumber>
</contact>
</recipient>
<pickupPoint>
<id>
736431
</id>
<countryCode>
DK
</countryCode>
</pickupPoint>
</parties>
<product>
<id>
PICKUP_PARCEL
</id>
<customerNumber>
6
</customerNumber>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>
1.1
</weightInKg>
<goodsDescription>
Testing equipment
</goodsDescription>
<dimensions>
<heightInCm>
13
</heightInCm>
<widthInCm>
23
</widthInCm>
<lengthInCm>
10
</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
You can specify pickup point Id in request for PICKUP_PARCEL_BULK
services for delivery of parcels to Finland from other countries. Use Pickup Point API to get list of nearest pickup points.
The parcel will be delivered to the pickup point specified in the request with SMS/Email notification. Pickup point delivery requires that the recipient has email and/or phone number set, so that he can receive notification when the package arrives at the pickup point.
Pickup point id and country code has to be specified under pickupPoint
within parties
as shown below.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": 1448632597124,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "12000",
"city": "Stockholm",
"countryCode": "SE",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "21200",
"city": "Raisio",
"countryCode": "FI",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": {
"id": "736431",
"countryCode": "FI"
}
},
"product": {
"id": "PICKUP_PARCEL_BULK",
"customerNumber": "6",
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>
1
</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>
2015-11-27T14:56:43.405+01:00
</shippingDateTime>
<parties>
<sender>
<name>
Ola Nordmann
</name>
<addressLine>
Testsvingen 12
</addressLine>
<postalCode>
12000
</postalCode>
<city>
Stockholm
</city>
<countryCode>
SE
</countryCode>
<reference>
1234
</reference>
<additionalAddressInfo>
Hentes på baksiden etter klokken to
</additionalAddressInfo>
<contact>
<name>
Trond Nordmann
</name>
<email>
trond@nordmanntest.no
</email>
<phoneNumber>
99999999
</phoneNumber>
</contact>
</sender>
<recipient>
<name>
Tore Mottaker
</name>
<addressLine>
Mottakerveien 14
</addressLine>
<addressLine2>
c/o Tina Mottaker
</addressLine2>
<postalCode>
21200
</postalCode>
<city>
Raisio
</city>
<countryCode>
FI
</countryCode>
<reference>
43242
</reference>
<additionalAddressInfo>
Bruk ringeklokken
</additionalAddressInfo>
<contact>
<name>
Tore mottaker
</name>
<email>
tore@mottakertest.no
</email>
<phoneNumber>
+46700000000
</phoneNumber>
</contact>
</recipient>
<pickupPoint>
<id>
736431
</id>
<countryCode>
FI
</countryCode>
</pickupPoint>
</parties>
<product>
<id>
PICKUP_PARCEL_BULK
</id>
<customerNumber>
6
</customerNumber>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>
1.1
</weightInKg>
<goodsDescription>
Testing equipment
</goodsDescription>
<dimensions>
<heightInCm>
13
</heightInCm>
<widthInCm>
23
</widthInCm>
<lengthInCm>
10
</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
You can use Express service if you want to send your goods urgently (this service is applicable only for Oil Express service). In case of express delivery, goods are picked up as soon as possible and delivered to its destination.
For using Express service send true
value in express
as shown in below example.
Media type: application/json
{
"schemaVersion": null,
"consignments": [
{
"shippingDateTime": 1448632597122,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": null
},
"product": {
"id": "OIL_EXPRESS",
"customerNumber": "**************",
"additionalServices": [
{
"id": "OX_EXPRESS"
}
],
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": "123",
"packageType": "ox_container",
"numberOfItems": 1,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": null
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="null">
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>
2015-11-27T14:56:43.424+01:00
</shippingDateTime>
<parties>
<sender>
<name>
Ola Nordmann
</name>
<addressLine>
Testsvingen 12
</addressLine>
<postalCode>
0263
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
1234
</reference>
<additionalAddressInfo>
Hentes på baksiden etter klokken to
</additionalAddressInfo>
<contact>
<name>
Trond Nordmann
</name>
<email>
trond@nordmanntest.no
</email>
<phoneNumber>
99999999
</phoneNumber>
</contact>
</sender>
<recipient>
<name>
Tore Mottaker
</name>
<addressLine>
Mottakerveien 14
</addressLine>
<addressLine2>
c/o Tina Mottaker
</addressLine2>
<postalCode>
0659
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
43242
</reference>
<additionalAddressInfo>
Bruk ringeklokken
</additionalAddressInfo>
<contact>
<name>
Tore mottaker
</name>
<email>
tore@mottakertest.no
</email>
<phoneNumber>
+46700000000
</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>
OIL_EXPRESS
</id>
<customerNumber>
**************
</customerNumber>
<additionalServices>
<additionalService>
<id>OX_EXPRESS</id>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>
1.1
</weightInKg>
<goodsDescription>
Testing equipment
</goodsDescription>
<dimensions>
<heightInCm>
13
</heightInCm>
<widthInCm>
23
</widthInCm>
<lengthInCm>
10
</lengthInCm>
</dimensions>
<containerId>
123
</containerId>
<packageType>
ox_container
</packageType>
<numberOfItems>
1
</numberOfItems>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The deliveryIndoors
element/attribute can be set for services that allow delivery indoors. This element must contain an instruction message for the driver.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": 1447751818783,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "10005",
"city": "STOCKHOLM",
"countryCode": "SE",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": null
},
"product": {
"id": "BUSINESS_PARCEL",
"customerNumber": "6",
"additionalServices": [
{
"id": "DELIVERY_INDOOR",
"message" : "Legg pakken i garasje"
}
],
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>
1
</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>
2015-12-22T20:04:33.131+01:00
</shippingDateTime>
<parties>
<sender>
<name>
Ola Nordmann
</name>
<addressLine>
Testsvingen 12
</addressLine>
<postalCode>
0263
</postalCode>
<city>
OSLO
</city>
<countryCode>
NO
</countryCode>
<reference>
1234
</reference>
<additionalAddressInfo>
Hentes på baksiden etter klokken to
</additionalAddressInfo>
<contact>
<name>
Trond Nordmann
</name>
<email>
trond@nordmanntest.no
</email>
<phoneNumber>
99999999
</phoneNumber>
</contact>
</sender>
<recipient>
<name>
Tore Mottaker
</name>
<addressLine>
Mottakerveien 14
</addressLine>
<addressLine2>
c/o Tina Mottaker
</addressLine2>
<postalCode>
10005
</postalCode>
<city>
STOCKHOLM
</city>
<countryCode>
SE
</countryCode>
<reference>
43242
</reference>
<additionalAddressInfo>
Bruk ringeklokken
</additionalAddressInfo>
<contact>
<name>
Tore mottaker
</name>
<email>
tore@mottakertest.no
</email>
<phoneNumber>
+46700000000
</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>
BUSINESS_PARCEL
</id>
<customerNumber>6</customerNumber>
<additionalServices>
<additionalService>
<id>DELIVERY_INDOOR</id>
<message>Legg pakken i garasjen.</message>
<email>sender@sender.com</email>
<mobile>777777</mobile>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>
1.1
</weightInKg>
<goodsDescription>
Testing equipment
</goodsDescription>
<dimensions>
<heightInCm>
13
</heightInCm>
<widthInCm>
23
</widthInCm>
<lengthInCm>
10
</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The incotermRule
element/attribute can be set for Cargo International service. This is a mandatory element while creating an order for Cargo International. API request will return error code i.e., BOOK-INPUT-065
in case of no IncotermRule is provided in request. This element allows either of 13 values DDP
, DAP
, FCA
, FAS
, FOB
, CFR
, CIF
, CPT
, CIP
, DAT
, DAF
, DES
and EXW
.
Media type: application/json
{
"bookingRequest": {
"-xmlns": "http://www.bring.no/booking/",
"-testIndicator": "true",
"schemaVersion": "1",
"consignments": {
"consignment": {
"-correlationId": "INTERNAL-123456",
"shippingDateTime": 1470846939000,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": "Testsvingen 12",
"postalCode": "0263",
"city": "OSLO",
"countryCode": "no",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter",
"contact": {
"name": "Trond Nordmann",
"email": "trond@normanntest.no",
"phoneNumber": "99999999"
}
},
"consignor": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": "Testsvingen 12",
"postalCode": "0263",
"city": "OSLO",
"countryCode": "no",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter to",
"vatNumber": "1000-1028527",
"contact": {
"name": "Trond Nordmann",
"email": "trond@normanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "10115",
"city": "BERLIN",
"countryCode": "DE",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore Mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "88888888"
}
},
"consignee": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "10115",
"city": "BERLIN",
"countryCode": "DE",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore Mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "88888888"
},
"vatNumber": "1000-1028527"
}
},
"product": {
"id": "CARGO_INTERNATIONAL",
"customerNumber": "**********",
"incotermRule": "DDP"
},
"packages": {
"package": {
"-correlationId": "PACKAGE-123",
"weightInKg": "1.1",
"dimensions": {
"heightInCm": "10",
"widthInCm": "10",
"lengthInCm": "10"
}
}
}
}
}
}
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2016-08-10T22:05:39.454+01:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<addressLine2>Testsvingen 12</addressLine2>
<postalCode>0263</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden etter</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email>trond@normanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<consignor>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<addressLine2>Testsvingen 12</addressLine2>
<postalCode>0263</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden etter to</additionalAddressInfo>
<vatNumber>1000-1028527</vatNumber>
<contact>
<name>Trond Nordmann</name>
<email>trond@normanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</consignor>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>10115</postalCode>
<city>BERLIN</city>
<countryCode>DE</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore Mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</recipient>
<consignee>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>10115</postalCode>
<city>BERLIN</city>
<countryCode>DE</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore Mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
<vatNumber>1000-1028527</vatNumber>
</consignee>
</parties>
<product>
<id>CARGO_INTERNATIONAL</id>
<customerNumber>*********</customerNumber>
<incotermRule>DDP</incotermRule>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>1.1</weightInKg>
<dimensions>
<heightInCm>10</heightInCm>
<widthInCm>10</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The dangerousGoods
attribute/element block should be there in request for Cargo International to create an order with dangerous goods.
Media type: application/json
{
"bookingRequest": {
"-xmlns": "http://www.bring.no/booking/",
"-testIndicator": "true",
"schemaVersion": "1",
"consignments": {
"consignment": {
"-correlationId": "INTERNAL-123456",
"shippingDateTime": 1470414939000,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": "Testsvingen 12",
"postalCode": "0263",
"city": "OSLO",
"countryCode": "no",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter",
"contact": {
"name": "Trond Nordmann",
"email": "trond@normanntest.no",
"phoneNumber": "99999999"
}
},
"consignor": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": "Testsvingen 12",
"postalCode": "0263",
"city": "OSLO",
"countryCode": "no",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter to",
"vatNumber": "1000-1028527",
"contact": {
"name": "Trond Nordmann",
"email": "trond@normanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "10115",
"city": "BERLIN",
"countryCode": "DE",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore Mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "88888888"
}
},
"consignee": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "10115",
"city": "BERLIN",
"countryCode": "DE",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore Mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "88888888"
},
"vatNumber": "1000-1028527"
}
},
"product": {
"id": "CARGO_INTERNATIONAL",
"customerNumber": "*********",
"incotermRule": "DDP",
"additionalServices": [
{
"id": "DANGEROUS_GOODS",
"containerId": "1236",
"weightInGrams": "500000",
"unNumber": "1560",
"commodity": "ARSENTRIKLORID",
"packingGroup": "I",
"dangerClass": "1",
"safetyMarkCode": "6.1"
}
]
},
"packages": {
"package": {
"-correlationId": "PACKAGE-123",
"weightInKg": "1.1",
"dimensions": {
"heightInCm": "10",
"widthInCm": "10",
"lengthInCm": "10"
}
}
}
}
}
}
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2016-08-05T22:05:39.454+01:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<addressLine2>Testsvingen 12</addressLine2>
<postalCode>0263</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden etter</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email>trond@normanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<consignor>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<addressLine2>Testsvingen 12</addressLine2>
<postalCode>0263</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden etter to</additionalAddressInfo>
<vatNumber>1000-1028527</vatNumber>
<contact>
<name>Trond Nordmann</name>
<email>trond@normanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</consignor>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>10115</postalCode>
<city>BERLIN</city>
<countryCode>DE</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore Mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</recipient>
<consignee>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>10115</postalCode>
<city>BERLIN</city>
<countryCode>DE</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore Mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
<vatNumber>1000-1028527</vatNumber>
</consignee>
</parties>
<product>
<id>CARGO_INTERNATIONAL</id>
<customerNumber>************</customerNumber>
<incotermRule>DDP</incotermRule>
<additionalServices>
<additionalService>
<id>DANGEROUS_GOODS</id>
<containerId>1236</containerId>
<weightInGrams>500000</weightInGrams>
<unNumber>1560</unNumber>
<commodity>ARSENTRIKLORID</commodity>
<packingGroup>I</packingGroup>
<dangerClass>1</dangerClass>
<tunnelRestrictionCode></tunnelRestrictionCode>
<safetyMarkCode>6.1</safetyMarkCode>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>1.1</weightInKg>
<dimensions>
<heightInCm>10</heightInCm>
<widthInCm>10</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The dangerousGoods
attribute/element block should be there in request for Cargo Norway to create an order with dangerous goods.
Media type: application/json
{
"bookingRequest": {
"-xmlns": "http://www.bring.no/booking/",
"-testIndicator": "true",
"schemaVersion": "1",
"consignments": {
"consignment": {
"-correlationId": "123456",
"shippingDateTime": 1470358449000,
"parties": {
"sender": {
"name": "Ola Danske",
"addressLine": "Testsvingen 12",
"postalCode": "4010",
"city": "Fredriksberg",
"countryCode": "NO",
"additionalAddressInfo": "Some pickup info",
"contact": {
"name": "Trond Nordmann",
"email": "trond@normanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Recipient",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Recipient",
"postalCode": "5954",
"city": "Glostrup",
"countryCode": "NO",
"contact": {
"name": "Tore Recipient",
"email": "tore@mottakertest.no",
"phoneNumber": "88888888"
}
}
},
"product": {
"id": "CARGO_GROUPAGE",
"customerNumber": "***********",
"additionalServices": [
{
"id": "DANGEROUS_GOODS",
"containerId": "1236",
"weightInGrams": "500000",
"unNumber": "1560",
"commodity": "ARSENTRIKLORID",
"packingGroup": "I",
"dangerClass": "1",
"safetyMarkCode": "6.1"
}
]
},
"packages": {
"package": {
"-correlationId": "123",
"weightInKg": "50",
"dimensions": {
"heightInCm": "200",
"widthInCm": "100",
"lengthInCm": "100"
}
}
}
}
}
}
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="123456">
<shippingDateTime>2016-08-05T06:24:09</shippingDateTime>
<parties>
<sender>
<name>Ola Danske</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>4010</postalCode>
<city>Fredriksberg</city>
<countryCode>NO</countryCode>
<additionalAddressInfo>Some pickup info</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email>trond@normanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Recipient</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Recipient</addressLine2>
<postalCode>5954</postalCode>
<city>Glostrup</city>
<countryCode>NO</countryCode>
<contact>
<name>Tore Recipient</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>CARGO_GROUPAGE</id>
<customerNumber>********</customerNumber>
<additionalServices>
<additionalService>
<id>DANGEROUS_GOODS</id>
<weightInGrams>500000</weightInGrams>
<containerId>1236</containerId>
<unNumber>1560</unNumber>
<commodity>ARSENTRIKLORID</commodity>
<packingGroup>I</packingGroup>
<dangerClass>1</dangerClass>
<tunnelRestrictionCode></tunnelRestrictionCode>
<safetyMarkCode>6.1</safetyMarkCode>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="123">
<weightInKg>50</weightInKg>
<dimensions>
<heightInCm>200</heightInCm>
<widthInCm>100</widthInCm>
<lengthInCm>100</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The simpleDelivery
element/attribute can be set for services that allow simple delivery.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": 1479547018000,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": null
},
"product": {
"id": "BPAKKE_DOR-DOR",
"customerNumber": "**********",
"additionalServices": [
{
"id": "SIMPLE_DELIVERY"
}
],
"messageForRecipient": null
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2016-11-17T14:54:33.208+01:00</shippingDateTime>
<parties>
<sender>
<name>Stian Mathiassen</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>0373</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden etter klokken to</additionalAddressInfo>
<contact>
<name>Test Testessen</name>
<email>test.testessen@some12.no</email>
<phoneNumber>95791102</phoneNumber>
</contact>
</sender>
<recipient>
<name>Komfortshop Skandinavia</name>
<addressLine>Avstikkeren 7</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>1156</postalCode>
<city>Oslo</city>
<countryCode>NO</countryCode>
<reference>Slavko Kozarac</reference>
<additionalAddressInfo></additionalAddressInfo>
<contact>
<name>Komfortshop Skandinavia</name>
<email>komfortshop.skandinavia@gmail.com</email>
<phoneNumber>92488435</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>BPAKKE_DOR-DOR</id>
<customerNumber>**********</customerNumber>
<additionalServices>
<additionalService>
<id>SIMPLE_DELIVERY</id>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>1.1</weightInKg>
<goodsDescription>Testing equipment</goodsDescription>
<dimensions>
<heightInCm>31</heightInCm>
<widthInCm>21</widthInCm>
<lengthInCm>6</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The numberOfPallets
element can be set for Number of pallets & loadMeters
can be set for Load Metres
Media type: application/json
{
"testIndicator": true,
"schemaVersion": 1,
"consignments": [
{
"correlationId": "123456",
"shippingDateTime": 1470358449000,
"parties": {
"sender": {
"name": "Ola Danske",
"addressLine": "Testsvingen 12",
"postalCode": "4010",
"city": "Fredriksberg",
"countryCode": "NO",
"additionalAddressInfo": "Some pickup info",
"contact": {
"name": "Trond Nordmann",
"email": "trond@normanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Recipient",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Recipient",
"postalCode": "5954",
"city": "Glostrup",
"countryCode": "NO",
"contact": {
"name": "Tore Recipient",
"email": "tore@mottakertest.no",
"phoneNumber": "88888888"
}
}
},
"product": {
"id": "CARGO_GROUPAGE",
"customerNumber": "**********"
},
"packages": [
{
"correlationId": "123",
"weightInKg": "50",
"volumeInDm3":2,
"numberOfPallets":2,
"loadMeters":1
}
]
}
]
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="123456">
<shippingDateTime>2019-02-05T06:24:09</shippingDateTime>
<parties>
<sender>
<name>Ola Danske</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>4010</postalCode>
<city>Fredriksberg</city>
<countryCode>NO</countryCode>
<additionalAddressInfo>Some pickup info</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email>trond@normanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Recipient</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Recipient</addressLine2>
<postalCode>5954</postalCode>
<city>Glostrup</city>
<countryCode>NO</countryCode>
<contact>
<name>Tore Recipient</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>CARGO_GROUPAGE</id>
<customerNumber>**********</customerNumber>
</product>
<packages>
<package correlationId="123">
<weightInKg>50</weightInKg>
<volumeInDm3>20</volumeInDm3>
<numberOfPallets>2</numberOfPallets>
<loadMeters>1.0</loadMeters>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The ediCustomsDeclarations
element needs one ediCustomsDeclaration
line per declared item. No importer party in the request.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": "2019-03-05T16:24:00",
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "12000",
"city": "Stockholm",
"countryCode": "SE",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"vatNumber": "12345",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": null
},
"product": {
"id": "BUSINESS_PARCEL",
"customerNumber": "PARCELS_NORWAY-***********",
"messageForRecipient": null,
"ediCustomsDeclarations": {
"ediCustomsDeclaration": [
{
"quantity": 2,
"goodsDescription": "shampoo",
"customsArticleNumber": "33.05.1000",
"itemNetWeightInKg": 3.0,
"tarriffLineAmount": 200,
"currency": "NOK",
"countryOfOrigin": "CH"
},
{
"quantity": 5,
"goodsDescription": "cotton t-shirts",
"customsArticleNumber": "61.09.1000",
"itemNetWeightInKg": 2.5,
"tarriffLineAmount": 1000,
"currency": "NOK",
"countryOfOrigin": "PL"
},
{
"quantity": 1,
"goodsDescription": "wool jacket",
"customsArticleNumber": "61.04.3100",
"itemNetWeightInKg": 2.0,
"tarriffLineAmount": 750,
"currency": "NOK",
"countryOfOrigin": "DE"
}
],
"natureOfTransaction": "GIFT"
}
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 5.0,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 10,
"widthInCm": 10,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2019-03-04T22:05:39.454+01:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>0150</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email>trond@normanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>12000</postalCode>
<city>stockholm</city>
<countryCode>se</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<vatNumber>12345</vatNumber>
<contact>
<name>Tore Mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>+46700000000</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>BUSINESS_PARCEL</id>
<customerNumber>PARCELS_NORWAY-***********</customerNumber>
<services>
<recipientNotification>
<email>sender@sender.com</email>
<mobile>777777</mobile>
</recipientNotification>
</services>
<ediCustomsDeclarations>
<natureOfTransaction>GIFT</natureOfTransaction>
<ediCustomsDeclaration>
<quantity>2</quantity>
<goodsDescription>shampoo</goodsDescription>
<customsArticleNumber>33.05.1000</customsArticleNumber>
<itemNetWeightInKg>3.0</itemNetWeightInKg>
<tarriffLineAmount>200</tarriffLineAmount>
<currency>NOK</currency>
<countryOfOrigin>CH</countryOfOrigin>
</ediCustomsDeclaration>
<ediCustomsDeclaration>
<quantity>5</quantity>
<goodsDescription>cotton t-shirts</goodsDescription>
<customsArticleNumber>61.09.1000</customsArticleNumber>
<itemNetWeightInKg>2.5</itemNetWeightInKg>
<tarriffLineAmount>1000</tarriffLineAmount>
<currency>NOK</currency>
<countryOfOrigin>PL</countryOfOrigin>
</ediCustomsDeclaration>
<ediCustomsDeclaration>
<quantity>1</quantity>
<goodsDescription>wool jacket</goodsDescription>
<customsArticleNumber>61.04.3100</customsArticleNumber>
<itemNetWeightInKg>2.0</itemNetWeightInKg>
<tarriffLineAmount>750</tarriffLineAmount>
<currency>NOK</currency>
<countryOfOrigin>DE</countryOfOrigin>
</ediCustomsDeclaration>
</ediCustomsDeclarations>
</product>
<purchaseOrder>
<purchaseOrderNumber>12345</purchaseOrderNumber>
</purchaseOrder>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>5.0</weightInKg>
<dimensions>
<heightInCm>10</heightInCm>
<widthInCm>10</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The ediCustomsDeclarations
element needs one ediCustomsDeclaration
line per declared item. An importer party is also in the request.
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": "2019-03-05T16:24:00",
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "12000",
"city": "Stockholm",
"countryCode": "SE",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"importer": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "12000",
"city": "Stockholm",
"countryCode": "SE",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"vatNumber": "12345",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"pickupPoint": null
},
"product": {
"id": "BUSINESS_PARCEL",
"customerNumber": "PARCELS_NORWAY-***********",
"messageForRecipient": null,
"ediCustomsDeclarations": {
"ediCustomsDeclaration": [
{
"quantity": 2,
"goodsDescription": "shampoo",
"customsArticleNumber": "33.05.1000",
"itemNetWeightInKg": 3.0,
"tarriffLineAmount": 200,
"currency": "NOK",
"countryOfOrigin": "CH"
},
{
"quantity": 5,
"goodsDescription": "cotton t-shirts",
"customsArticleNumber": "61.09.1000",
"itemNetWeightInKg": 2.5,
"tarriffLineAmount": 1000,
"currency": "NOK",
"countryOfOrigin": "PL"
},
{
"quantity": 1,
"goodsDescription": "wool jacket",
"customsArticleNumber": "61.04.3100",
"itemNetWeightInKg": 2.0,
"tarriffLineAmount": 750,
"currency": "NOK",
"countryOfOrigin": "DE"
}
],
"natureOfTransaction": "GIFT"
}
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 5.0,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 10,
"widthInCm": 10,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2019-03-04T22:05:39.454+01:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>0150</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email>trond@normanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>12000</postalCode>
<city>stockholm</city>
<countryCode>se</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore Mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>+46700000000</phoneNumber>
</contact>
</recipient>
<importer>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>12000</postalCode>
<city>stockholm</city>
<countryCode>se</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<vatNumber>12345</vatNumber>
<contact>
<name>Tore Mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>+46700000000</phoneNumber>
</contact>
</importer>
</parties>
<product>
<id>BUSINESS_PARCEL</id>
<customerNumber>PARCELS_NORWAY-***********</customerNumber>
<services>
<recipientNotification>
<email>sender@sender.com</email>
<mobile>777777</mobile>
</recipientNotification>
</services>
<ediCustomsDeclarations>
<natureOfTransaction>GIFT</natureOfTransaction>
<ediCustomsDeclaration>
<quantity>2</quantity>
<goodsDescription>shampoo</goodsDescription>
<customsArticleNumber>33.05.1000</customsArticleNumber>
<itemNetWeightInKg>3.0</itemNetWeightInKg>
<tarriffLineAmount>200</tarriffLineAmount>
<currency>NOK</currency>
<countryOfOrigin>CH</countryOfOrigin>
</ediCustomsDeclaration>
<ediCustomsDeclaration>
<quantity>5</quantity>
<goodsDescription>cotton t-shirts</goodsDescription>
<customsArticleNumber>61.09.1000</customsArticleNumber>
<itemNetWeightInKg>2.5</itemNetWeightInKg>
<tarriffLineAmount>1000</tarriffLineAmount>
<currency>NOK</currency>
<countryOfOrigin>PL</countryOfOrigin>
</ediCustomsDeclaration>
<ediCustomsDeclaration>
<quantity>1</quantity>
<goodsDescription>wool jacket</goodsDescription>
<customsArticleNumber>61.04.3100</customsArticleNumber>
<itemNetWeightInKg>2.0</itemNetWeightInKg>
<tarriffLineAmount>750</tarriffLineAmount>
<currency>NOK</currency>
<countryOfOrigin>DE</countryOfOrigin>
</ediCustomsDeclaration>
</ediCustomsDeclarations>
</product>
<purchaseOrder>
<purchaseOrderNumber>12345</purchaseOrderNumber>
</purchaseOrder>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>5.0</weightInKg>
<dimensions>
<heightInCm>10</heightInCm>
<widthInCm>10</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
Recipient phoneNumber
and/or recipient email
is required
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": "2019-10-22T12:30:00.000+02:00",
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"returnTo": {
"name": "ABC",
"addressLine": "Alf Bjerckes vei 29",
"addressLine2": "",
"postalCode": "0582",
"city": "OSLO",
"countryCode": "NO"
},
"pickupPoint": null
},
"product": {
"id": "3584",
"customerNumber": "*************",
"additionalServices": [
{
"id": "1081"
}
]
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2019-10-22T12:30:00.000+02:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>0263</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>1234</reference>
<contact>
<name>Trond Nordmann</name>
<email>trond@nordmanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>0659</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>43242</reference>
<contact>
<name>Tore mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</recipient>
<returnTo>
<name>ABC</name>
<addressLine>Alf Bjerckes vei 29</addressLine>
<addressLine2></addressLine2>
<postalCode>0582</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
</returnTo>
</parties>
<product>
<id>3584</id>
<customerNumber>*************</customerNumber>
<additionalServices>
<additionalService>
<id>1081</id>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>1.1</weightInKg>
<goodsDescription>Testing equipment</goodsDescription>
<dimensions>
<heightInCm>13</heightInCm>
<widthInCm>23</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The LQ VAS gross weight is specified in grams
Media type: application/json
{
"bookingRequest": {
"-xmlns": "http://www.bring.no/booking/",
"-testIndicator": "true",
"schemaVersion": "1",
"consignments": {
"consignment": {
"-correlationId": "INTERNAL-123456",
"shippingDateTime": 1470414939000,
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": "Testsvingen 12",
"postalCode": "2600",
"city": "GLOSTRUP",
"countryCode": "dk",
"reference": "1234",
"additionalAddressInfo": "Hentes på baksiden etter klokken to",
"contact": {
"name": "Trond Nordmann",
"email": "trond@normanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "65601",
"city": "KARLSTAD",
"countryCode": "SE",
"reference": "43242",
"additionalAddressInfo": "Bruk ringeklokken",
"contact": {
"name": "Tore Mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46720000000"
}
}
},
"product": {
"id": "BUSINESS_PARCEL",
"customerNumber": "6",
"additionalServices": [
{
"id": "0003",
"limitedQuantitiesGrossWeight": "200"
}
],
"ediCustomsDeclarations": {
"ediCustomsDeclaration": [
{
"quantity": 1,
"goodsDescription": "hair spray",
"itemNetWeightInKg": 1.0,
"tarriffLineAmount": 200,
"currency": "NOK",
"countryOfOrigin": "DK"
}
],
"otherNatureOfTransactionDescription": "testing",
"natureOfTransaction": "OTHER"
}
},
"packages": {
"package": {
"-correlationId": "PACKAGE-123",
"weightInKg": "1.1",
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": "13",
"widthInCm": "23",
"lengthInCm": "10"
}
}
}
}
}
}
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2021-10-03T21:31:33.007+02:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>2600</postalCode>
<city>GLOSTRUP</city>
<countryCode>dk</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden etter klokken to</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email>trond@nordmanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>65601</postalCode>
<city>Karlstad</city>
<countryCode>SE</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>+46720000000</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>BUSINESS_PARCEL</id>
<customerNumber>6</customerNumber>
<additionalServices>
<additionalService>
<id>0003</id>
<limitedQuantitiesGrossWeight>200</limitedQuantitiesGrossWeight>
</additionalService>
</additionalServices>
<ediCustomsDeclarations>
<natureOfTransaction>OTHER</natureOfTransaction>
<otherNatureOfTransactionDescription>test</otherNatureOfTransactionDescription>
<ediCustomsDeclaration>
<quantity>1</quantity>
<goodsDescription>hair spray</goodsDescription>
<itemNetWeightInKg>1.0</itemNetWeightInKg>
<tarriffLineAmount>200</tarriffLineAmount>
<currency>NOK</currency>
<countryOfOrigin>DK</countryOfOrigin>
</ediCustomsDeclaration>
</ediCustomsDeclarations>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>1.1</weightInKg>
<goodsDescription>Testing equipment</goodsDescription>
<dimensions>
<heightInCm>13</heightInCm>
<widthInCm>23</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
Return Parcel Id
is required and Additional VAS is optional
Media type: application/json
{
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": "2019-10-22T12:30:00.000+02:00",
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
},
"returnTo": {
"name": "ABC",
"addressLine": "Alf Bjerckes vei 29",
"addressLine2": "",
"postalCode": "0582",
"city": "OSLO",
"countryCode": "NO"
},
"pickupPoint": null
},
"product": {
"id": "3584",
"customerNumber": "*************",
"additionalServices": [
{
"id": "1081"
}
]
},
"returnProduct": {
"id":"9650",
"additionalServices": [
{
"id": "1073"
}
]
},
"purchaseOrder": null,
"correlationId": "INTERNAL-123456",
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
],
"testIndicator": true
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2019-10-22T12:30:00.000+02:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>0263</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>1234</reference>
<contact>
<name>Trond Nordmann</name>
<email>trond@nordmanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>0659</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>43242</reference>
<contact>
<name>Tore mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</recipient>
<returnTo>
<name>ABC</name>
<addressLine>Alf Bjerckes vei 29</addressLine>
<addressLine2></addressLine2>
<postalCode>0582</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
</returnTo>
</parties>
<product>
<id>3584</id>
<customerNumber>*************</customerNumber>
<additionalServices>
<additionalService>
<id>1081</id>
</additionalService>
</additionalServices>
</product>
<returnProduct>
<id>3584</id>
<additionalServices>
<additionalService>
<id>1073</id>
</additionalService>
</additionalServices>
</returnProduct>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>1.1</weightInKg>
<goodsDescription>Testing equipment</goodsDescription>
<dimensions>
<heightInCm>13</heightInCm>
<widthInCm>23</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
The nonStandardCourierProductCode
is required
Media type: application/json
{
"testIndicator": true,
"schemaVersion": 1,
"consignments": [
{
"shippingDateTime": "2020-07-16T20:30:00.000+02:00",
"parties": {
"sender": {
"name": "Ola Nordmann",
"addressLine": "Testsvingen 12",
"addressLine2": null,
"postalCode": "0263",
"city": "OSLO",
"countryCode": "NO",
"reference": "1234",
"contact": {
"name": "Trond Nordmann",
"email": "trond@nordmanntest.no",
"phoneNumber": "99999999"
}
},
"recipient": {
"name": "Tore Mottaker",
"addressLine": "Mottakerveien 14",
"addressLine2": "c/o Tina Mottaker",
"postalCode": "0659",
"city": "OSLO",
"countryCode": "NO",
"reference": "43242",
"contact": {
"name": "Tore mottaker",
"email": "tore@mottakertest.no",
"phoneNumber": "+46700000000"
}
}
},
"product": {
"id": "NON_STANDARD_COURIER",
"nonStandardCourierProductCode": "CDA",
"customerNumber": "EXPRESS_NORWAY-********-****-****-****-************"
},
"packages": [
{
"weightInKg": 1.1,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"containerId": null,
"packageType": null,
"numberOfItems": null,
"correlationId": "PACKAGE-123"
}
]
}
]
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2020-07-16T20:30:00.000+02:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>0263</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>1234</reference>
<contact>
<name>Trond Nordmann</name>
<email>trond@nordmanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>0659</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>43242</reference>
<contact>
<name>Tore mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>+46700000000</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>NON_STANDARD_COURIER</id>
<nonStandardCourierProductCode>CDA</nonStandardCourierProductCode>
<customerNumber>EXPRESS_NORWAY-********-****-****-****-************</customerNumber>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>1.1</weightInKg>
<goodsDescription>Testing equipment</goodsDescription>
<dimensions>
<heightInCm>13</heightInCm>
<widthInCm>23</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
Additional VAS is optional
Media type: application/json
{
"testIndicator": false,
"schemaVersion": 1,
"clientUrl": "www.google.com",
"consignments": [
{
"shippingDateTime": 1591967669154,
"parties": {
"sender": {
"name": "DUMMY NAME",
"addressLine": "ABCD , 1",
"addressLine2": "LOC.CASELLA",
"postalCode": "0150",
"city": "OSLO",
"countryCode": "NO",
"reference": "0SPA0001007",
"contact": {
"name": "Dummy sender",
"phoneNumber": "0988 24322",
"email": "dummy.id@test.com"
}
},
"recipient": {
"name": "DUMMY RECIPIENT",
"addressLine": "DUMMY ADDRESS1",
"addressLine2": "DUMMY ADDRESS2",
"postalCode": "54291",
"city": "STOCKHOLM",
"countryCode": "SE",
"reference": "ref",
"contact": {
"name": "Recipient name",
"phoneNumber": "0424 343233",
"email": "d.d@f.d"
}
}
},
"product": {
"id": "3332",
"customerNumber": "PARCELS_NORWAY-xxxxxxxx",
"additionalServices": [
{
"id": "FLEX_DELIVERY",
"message": "est Delivery Indoor"
}
]
},
"packages": [
{
"weightInKg": 2,
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
}
}
]
}
]
}
Media type: application/xml
<bookingRequest testIndicator="false" xmlns="http://www.bring.no/booking/">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="0SPA0001007">
<shippingDateTime>2020-06-10T23:02:02+01:00</shippingDateTime>
<parties>
<sender>
<name>DUMMY NAME</name>
<addressLine>ABCD , 1</addressLine>
<addressLine2>LOC.CASELLA</addressLine2>
<postalCode>0150</postalCode>
<city>OSLO</city>
<countryCode>NO</countryCode>
<reference>0SPA0001007</reference>
<contact>
<name>Dummy sender</name>
<email>dummy.id@test.com</email>
<phoneNumber>0988 24322</phoneNumber>
</contact>
</sender>
<recipient>
<name>DUMMY RECIPIENT</name>
<addressLine>DUMMY ADDRESS1</addressLine>
<addressLine2>DUMMY ADDRESS2</addressLine2>
<postalCode>54291</postalCode>
<city>Stockholm</city>
<countryCode>SE</countryCode>
<reference>ref</reference>
<contact>
<name>Recipient name</name>
<email>d.d@f.d</email>
<phoneNumber>0424 343233</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>3332</id>
<customerNumber>PARCELS_NORWAY-xxxxxxxx</customerNumber>
<additionalServices>
<additionalService>
<id>FLEX_DELIVERY</id>
<message>Test Delivery Indoor</message>
</additionalService>
</additionalServices>
</product>
<packages>
<package>
<weightInKg>2</weightInKg>
<goodsDescription></goodsDescription>
<dimensions>
<heightInCm>13</heightInCm>
<widthInCm>23</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
Home Delivery services can be booked with Weight and either Volume / Dimensions
Media type: application/json
{
"testIndicator": true,
"schemaVersion": 1,
"clientUrl": "www.google.com",
"consignments": [
{
"shippingDateTime": "2020-10-15T12:30:00.000+02:00",
"parties": {
"sender": {
"name": "DUMMY NAME",
"addressLine": "ABCD , 1",
"addressLine2": "LOC.CASELLA",
"postalCode": "0150",
"city": "OSLO",
"countryCode": "NO",
"reference": "0SPA0001007",
"contact": {
"name": "Dummy sender",
"phoneNumber": "0988 24322",
"email": "dummy.id@test.com"
}
},
"recipient": {
"name": "DUMMY RECIPIENT",
"addressLine": "DUMMY ADDRESS1",
"addressLine2": "DUMMY ADDRESS2",
"postalCode": "0150",
"city": "OSLO",
"countryCode": "NO",
"reference": "ref",
"contact": {
"name": "Recipient name",
"phoneNumber": "0424 343233",
"email": "d.d@f.d"
},
"additionalAddressInfo": "Bruk ringeklokke"
}
},
"product": {
"id": "DOUBLE_INDOOR",
"customerNumber": "PARCELS_NORWAY-xxxxxxxx",
"explicitAdditionalServices": false
},
"packages": [
{
"weightInKg": 2,
"volumeInDm3": 10,
"packageType": "hd_half"
}
]
}
]
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2020-10-14T17:31:33.007+02:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>0150</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden etter klokken to</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email></email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>0150</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>DOUBLE_INDOOR</id>
<customerNumber>PARCELS_NORWAY-xxxxxxxx</customerNumber>
</product>
<packages>
<package correlationId="PACKAGE-123">
<packageType>hd_half</packageType>
<weightInKg>2</weightInKg>
<goodsDescription>Test</goodsDescription>
<volumeInDm3>10</volumeInDm3>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
Home Delivery services can be booked with Weight and either Volume / Dimensions
Media type: application/json
{
"testIndicator": true,
"schemaVersion": 1,
"clientUrl": "www.google.com",
"consignments": [
{
"shippingDateTime": "2020-10-15T12:30:00.000+02:00",
"parties": {
"sender": {
"name": "DUMMY NAME",
"addressLine": "ABCD , 1",
"addressLine2": "LOC.CASELLA",
"postalCode": "10004",
"city": "STOCKHOLM",
"countryCode": "SE",
"reference": "0SPA0001007",
"contact": {
"name": "Dummy sender",
"phoneNumber": "0988 24322",
"email": "dummy.id@test.com"
}
},
"recipient": {
"name": "DUMMY RECIPIENT",
"addressLine": "DUMMY ADDRESS1",
"addressLine2": "DUMMY ADDRESS2",
"postalCode": "12058",
"city": "Arsta",
"countryCode": "SE",
"reference": "ref",
"contact": {
"name": "Recipient name",
"phoneNumber": "0424 343233",
"email": "d.d@f.d"
},
"additionalAddressInfo": "Bruk ringeklokke"
}
},
"product": {
"id": "CURBSIDE_EVENING",
"customerNumber": "PARCELS_NORWAY-xxxxxxxx",
"explicitAdditionalServices": false
},
"packages": [
{
"weightInKg": 2,
"goodsDescription": "Testing equipment",
"dimensions": {
"heightInCm": 13,
"widthInCm": 23,
"lengthInCm": 10
},
"packageType": "hd_half"
}
]
}
]
}
Media type: application/xml
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<clientUrl>https://example.com/</clientUrl>
<consignments>
<consignment correlationId="0SPA0001007">
<shippingDateTime>2020-10-15T00:23:02+02:00</shippingDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>10004</postalCode>
<city>Stockholm</city>
<countryCode>SE</countryCode>
<reference>1234</reference>
<contact>
<name>Tore mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<postalCode>12058</postalCode>
<city>Arsta</city>
<countryCode>SE</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>CURBSIDE_EVENING</id>
<customerNumber>PARCELS_NORWAY-xxxxxxxx</customerNumber>
<explicitAdditionalServices>false</explicitAdditionalServices>
</product>
<packages>
<package>
<weightInKg>1.26</weightInKg>
<goodsDescription/>
<dimensions>
<heightInCm>13</heightInCm>
<widthInCm>23</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
<packageType>hd_quarter</packageType>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
Error codes
https://api.bring.com/booking/api/errors
The current enumeration of error codes. A value of “true” for the attribute “suffixable” means that the error code is suffixed with “-SENDER” if the error is for the sending party data and “-RECIPIENT” if the error is for the recipient party data.
Request parameters
HTTP header | Type | Description |
---|---|---|
Accept |
application/json or application/xml |
Required |
Request body
Media type: application/json
{
"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": "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-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",
"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 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-051",
"message": "Missing required Danger class 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-056",
"message": "Evening Delivery is not supported for given product",
"suffixable": false
},
{
"code": "BOOK_INPUT-057",
"message": "Invalid postal Code",
"suffixable": true
},
{
"code": "BOOK_INPUT-058",
"message": "Guided booking is currently allowed only in Norway.",
"suffixable": false
},
{
"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-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-076",
"message": "Dangerous goods cannot be booked with non freeze",
"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 available in Sweden only.",
"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-007",
"message": "Delivery indoor is available in Sweden and Denmark only.",
"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, tarriff line amount or 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-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": "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-dd",
"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 or 5600",
"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": "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
}
]
}
Media type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errorTypeList xmlns="http://www.bring.no/booking/">
<errorTypes>
<errorType>
<code>BOOK-INPUT-001</code>
<message>Bad request</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-002</code>
<message>Weight is required</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-003</code>
<message>Schema version must be present</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-004</code>
<message>At least one consignment must be specified</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-005</code>
<message>Multiple consignments in one booking is not supported</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-006</code>
<message>Sender must be specified</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-007</code>
<message>Recipient must be specified</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-008</code>
<message>Product must be set</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-009</code>
<message>Package or Package Group must be specified</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-011</code>
<message>Multiple packages in one booking is not supported</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-012</code>
<message>Shipping date and time must be provided</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-013</code>
<message>Package dimensions must be provided</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-014</code>
<message>Name must be provided</message>
<suffixable>true</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-015</code>
<message>Address must be provided</message>
<suffixable>true</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-016</code>
<message>City must be provided</message>
<suffixable>true</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-017</code>
<message>ISO Country code must be provided</message>
<suffixable>true</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-018</code>
<message>Product ID must be provided</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-019</code>
<message>Customer number must be provided</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-020</code>
<message>Invalid product ID</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-021</code>
<message>Invalid customer number</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-022</code>
<message>Illegal product for country</message>
<suffixable>true</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-023</code>
<message>The shipment is too big to send with the given product</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-024</code>
<message>The product is not available between the given addresses (outside coverage)</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-025</code>
<message>The product is not available between the given countries</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-027</code>
<message>Failed because of product specific requirements</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-028</code>
<message>Invalid country code</message>
<suffixable>true</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-029</code>
<message>Invalid customer number for sender country and product</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-030</code>
<message>Please set the testIndicator attribute on the request (true = test booking, false = production booking)</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-031</code>
<message>You must specify number of packages (pieces) included in the package group</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-032</code>
<message>Multiple packages are not supported for this product</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-033</code>
<message>Package groups are not supported for this product</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-034</code>
<message>Multiple package groups are not supported for this product</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-035</code>
<message>Invalid value for QuickPack Envelope. Must be boolean lower case.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-036</code>
<message>Invalid currency code, use ISO 4217 currency code</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-037</code>
<message>Missing required input for cash on delivery. amount, currency and account are required.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-038</code>
<message>Invalid message type for cash on delivery.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-039</code>
<message>Delivery option is invalid.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-040</code>
<message>Delivery option is not applicable for this product.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-041</code>
<message>Invalid purchase order number</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-043</code>
<message>The customer does not have a return agreement for that country/product.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-044</code>
<message>Missing required input for cash on delivery. account type is required for Sweden.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-045</code>
<message>Could not find a pickup point for the provided recipient</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-046</code>
<message>Non freeze should be lowercase true or false.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-047</code>
<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 within NORWAY.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-048</code>
<message>Missing required UNNumber for Dangerous goods.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-049</code>
<message>Missing required Commodity for Dangerous goods.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-050</code>
<message>Missing required Weight for Dangerous goods.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-051</code>
<message>Missing required Danger class for Dangerous goods.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-052</code>
<message>Missing required Container Id for Oil Express Product</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-053</code>
<message>Dangerous Goods Container Id should match with one of the container Id in Package List</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-054</code>
<message>Invalid amount for Cash On Delivery, use amount with two decimal places only</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_INPUT-055</code>
<message>Dangerous Goods is not supported for given product</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_INPUT-056</code>
<message>Evening Delivery is not supported for given product</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_INPUT-057</code>
<message>Invalid postal Code</message>
<suffixable>true</suffixable>
</errorType>
<errorType>
<code>BOOK_INPUT-058</code>
<message>Guided booking is currently allowed only in Norway.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_INPUT-059</code>
<message>Invalid input provided. Not able to parse the input successfully.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_INPUT-060</code>
<message>Missing booking request</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_INPUT-061</code>
<message>Maximum 400 characters are allowed in Message For Recipient field.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-062</code>
<message>Missing required message input for delivery indoor</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-063</code>
<message>Consignor must be specified</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-064</code>
<message>Consignee must be specified</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-065</code>
<message>Incoterm must be specified</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-070</code>
<message>The product is not available</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-071</code>
<message>Invalid package type for Home Delivery product. Available options: 'hd_eur', 'hd_half', 'hd_quarter', 'hd_loose'</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-072</code>
<message>Missing both recipient phone number and mobile number.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-073</code>
<message>Invalid package type for Home Delivery product. Available options: 'hd_eur', 'hd_half', 'hd_loose'</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-074</code>
<message>Only one of [packages, packageGroups] can be set</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-075</code>
<message>Dangerous goods cannot be booked with simple delivery</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INPUT-076</code>
<message>Dangerous goods cannot be booked with non freeze</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-AUTHORIZATION-001</code>
<message>Your user is not authorized to perform this action</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-VALIDATION-001</code>
<message>Unexpected business validation rule failure</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-002</code>
<message>A valid mobile phone number or email address is required for eVarsling</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-003</code>
<message>Country is not a member of Universal Postal Union</message>
<suffixable>true</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-004</code>
<message>Phone Notification is available in Sweden only.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-005</code>
<message>Phone Notification should be true.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-006</code>
<message>Phone Notification requires recipient number to be present.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-007</code>
<message>Delivery indoor is available in Sweden and Denmark only.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-008</code>
<message>Illegal argument.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-009</code>
<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.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-010</code>
<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.</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-011</code>
<message>A valid recipient mobile number or email address is required for notification</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-012</code>
<message>A valid quantity, goods description, tarriff line amount or item net weight is required for customs declaration</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-013</code>
<message>Nature of transaction required for using customs declarations</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-014</code>
<message>Customs declarations are required for exporting this product from Norway</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-015</code>
<message>Total weight stated in the customs information exceeds the allowed max weight for this service</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK_VALIDATION-016</code>
<message>One or more additional services is not allowed for this customer</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INTERNAL-001</code>
<message>An unexpected error occurred</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>BOOK-INTERNAL-002</code>
<message>A required external service is unavailable</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INTERNAL-001</code>
<message>An unexpected error occurred</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-001</code>
<message>Error with input in pickupOrder</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-002</code>
<message>Postal code must be given and be valid</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-003</code>
<message>Cargo customer must provide cargoInformation element. Parcel customer must provide parcelsInformation element</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-004</code>
<message>This customer number cannot be used to order Pickup</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-005</code>
<message>You must specify pickupIsReadyAtTime element HH:mm:ss</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-006</code>
<message>You must specify pickupDate element yyyy-MM-dd</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-007</code>
<message>Pickup date must be in the future</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-008</code>
<message>weightInGrams is required, and must be an integer larger than zero</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-009</code>
<message>Must be an integer larger than zero</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-010</code>
<message>Country code is required</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-011</code>
<message>Both Pickup Point ID and Country Code is Required</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-012</code>
<message>Selected pickup point should be in recipient country</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>PICKUP-INPUT-013</code>
<message>Combination pickupIsReadyAtTime and pickupDate must be in the future</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-001</code>
<message>Customer specified delivery date must be in the future</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-002</code>
<message>Customer specified delivery date must have valid values and be in format yyyy-MM-dd</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-003</code>
<message>Customer specified delivery date can not be null</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-004</code>
<message>Customer specified delivery date is valid for Products: PA_DOREN or 5600</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-005</code>
<message>Customer specified delivery date is not available in expected/alternative delivery dates</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>CUSTOMER_SPECIFIED_DELIVERY_DATE-INPUT-006</code>
<message>Customer specified delivery date must be after Shipping date</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>NETS_TRANSACTION_INPUT-001</code>
<message>Missing Nets transaction request</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>NETS_TRANSACTION_INPUT-002</code>
<message>Missing Nets transaction id</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>NETS_TRANSACTION_INPUT-003</code>
<message>Missing Bring consignment number</message>
<suffixable>false</suffixable>
</errorType>
<errorType>
<code>NETS_TRANSACTION_INPUT-004</code>
<message>Missing customer number</message>
<suffixable>false</suffixable>
</errorType>
</errorTypes>
</errorTypeList>
Order pickups
https://api.bring.com/booking/api/pickupOrder
The Pickup Order API is for ordering a single pickup at a particular address.
Parcels Norway, Parcels Sweden, Parcels Denmark and Cargo customers with a Mybring user ID can use this service. Customer numbers in this API are the same as to the Booking API, obtained either through your Mybring profile or the customer number API.
We have added new tags for new way of requesting pickup. Both ways are still supported, but they can not be combined.
- All the new pickup services will be added supporting only the new way.
- The old way will be decommissioned after some time.
Where before you had to send different tags under the pickupOrderRequest
tag for ordering different types of pickup .
Now the new way introduced two tags service
and pickupDetails
under pickupOrderRequest
tag , one to capture type of service you wanted to book and one to capture what will be picked up.
Example: Ordering pickup for parcel shipments in Norway
The new way of requesting pickup
<service>PARCEL</service>
<pickupDetails>
<numberOfPackages>1</numberOfPackages>
<numberOfPostContainers>1</numberOfPostContainers>
<numberOfPallets>1</numberOfPallets>
</pickupDetails>
The old way of requesting pickup:
<parcelsInformation>
<numberOfPackages>1</numberOfPackages>
<numberOfPostContainers>1</numberOfPostContainers>
<numberOfPallets>1</numberOfPallets>
</parcelsInformation>
Pickup in the different countries requires different customer numbers:
Customer number prefix | Pickup in country | Required information element |
---|---|---|
None, PARCELS_NORWAY | Norway (parcel services) | <service>PARCEL</service> & <pickupDetails></pickupDetails> |
None, CARGO | Norway (cargo services) | <service>CARGO</service> & <pickupDetails></pickupDetails> |
None, PARCELS_SWEDEN, PARCELS_DENMARK | Sweden, Denmark (parcel services) | <service>PARCEL</service> & <pickupDetails></pickupDetails> |
If your company has been converted to services with new service names (revised services) in Booking and Shipping Guide, pickup of parcels and/or cargo in Norway and Nordics is done using your company’s new API customer number - i.e your company’s main customer number. You company’s main customer number equals your PARCELS_xx-*********** customer number, without prefix PARCELS_xx- and any leading zeros.
Pickup is ordered by default with service CARGO_GROUPAGE from Bring Cargo
A pickup order is necessary to get the goods collected for transportation by Bring Cargo but you don’t have to worry about it when ordering with the API .
A pickup will be automatically ordered together with the shipment when ordering a CARGO_GROUPAGE
shipment.
If you order many shipments the pickups will be aggregated by Bring Cargo to one pickup by place and date.
Request body
Media type: application/json
{
"customerInformation": {
"customerNumber": "************",
"companyName": "Norsk Bedrift AS"
},
"pickupAddress": {
"street": "Testsvingen 12",
"postalCode": "0263",
"city": "OSLO",
"email": "norsk.bedrift@example.com",
"phoneNumber": "99999999",
"message": "Hentes på baksiden"
},
"pickupDate": "2015-12-03",
"pickupIsReadyAtTime": null,
"pickupTimeZone": null,
"countryCode": "NO",
"service": "PARCEL",
"pickupDetails": {
"numberOfPackages": 2,
"numberOfPostContainers": 0,
"numberOfPallets": 1
},
"testIndicator": true
}
Media type: application/xml
<pickupOrderRequest xmlns="http://www.bring.no/booking/" testIndicator="false">
<customerInformation>
<customerNumber>*************</customerNumber>
<companyName>Norsk Bedrift AS</companyName>
</customerInformation>
<pickupAddress>
<street>
Testsvingen 12
</street>
<postalCode>
0263
</postalCode>
<email>
norsk.bedrift@example.com
</email>
<phoneNumber>
99999999
</phoneNumber>
<city>
OSLO
</city>
<messageToDriver>
Hentes på baksiden
</messageToDriver>
</pickupAddress>
<pickupDate>
2019-02-04
</pickupDate>
<service>PARCEL</service>
<pickupDetails>
<numberOfPackages>
2
</numberOfPackages>
<numberOfPostContainers>
0
</numberOfPostContainers>
<numberOfPallets>
1
</numberOfPallets>
</pickupDetails>
<countryCode>
NO
</countryCode>
</pickupOrderRequest>
Responses
HTTP status code 200
Media type: application/json
{
"pickupConfirmation": {
"status": "OK",
"earliestPickupDate": 1449097200000,
"latestPickupDate": 1449183600000,
"url": "http://www.mybring.com/order/pickup/receipt/xxxx",
"packageNumber": "370438101662588325"
},
"errors": null
}
{
"customerInformation": {
"customerNumber": "*************",
"companyName": "Svensk Bedrift AS"
},
"pickupAddress": {
"street": "Testsvingen 12",
"postalCode": "11234",
"city": "Stockholm",
"email": "svensk.bedrift@example.com",
"phoneNumber": "99999999",
"message": "Hentes på baksiden"
},
"pickupDate": "2015-12-03",
"pickupIsReadyAtTime": null,
"pickupTimeZone": null,
"countryCode": "SV",
"service": "PARCEL",
"pickupDetails": {
"numberOfPackages": 2,
"numberOfPallets": 1,
"weightInGrams": 2
},
"testIndicator": true
}
{
"customerInformation": {
"customerNumber": "*******",
"companyName": "Norsk Bedrift AS"
},
"pickupAddress": {
"street": "Testsvingen 12",
"postalCode": "0263",
"city": "OSLO",
"email": "norsk.bedrift@example.com",
"phoneNumber": "99999999",
"message": "Hentes på baksiden"
},
"pickupDate": "2015-12-03",
"pickupIsReadyAtTime": "14:26",
"pickupTimeZone": "Europe/Oslo",
"countryCode": "NO",
"service": "CARGO",
"pickupDetails": {
"numberOfPackages": 1,
"weightInGrams": 70000,
"volumeInDm3": 40
},
"testIndicator": true
}
Media type: application/xml
<pickupOrderResponse xmlns="http://www.bring.no/booking/">
<pickupConfirmation>
<status>
OK
</status>
<earliestPickupDate>
2015-12-04T00:00:00+01:00
</earliestPickupDate>
<latestPickupDate>
2015-12-05T00:00:00+01:00
</latestPickupDate>
<url>http://www.mybring.com/order/pickup/receipt/xxxx</url>
<packageNumber>370438101662588325</packageNumber>
</pickupConfirmation>
</pickupOrderResponse>
<pickupOrderRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<customerInformation>
<customerNumber>
***************
</customerNumber>
<companyName>
Svensk Bedrift AS
</companyName>
</customerInformation>
<pickupAddress>
<street>
Testsvingen 12
</street>
<postalCode>
11234
</postalCode>
<email>
svensk.bedrift@example.com
</email>
<phoneNumber>
99999999
</phoneNumber>
<city>
Stockholm
</city>
<messageToDriver>
Hentes på baksiden
</messageToDriver>
</pickupAddress>
<pickupDate>
2015-12-04
</pickupDate>
<countryCode>
SV
</countryCode>
<service>PARCEL</service>
<pickupDetails>
<numberOfPackages>
2
</numberOfPackages>
<numberOfPallets>
1
</numberOfPallets>
<weightInGrams>
2
</weightInGrams>
</pickupDetails>
</pickupOrderRequest>
<pickupOrderRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<customerInformation>
<customerNumber>
*********
</customerNumber>
<companyName>
Norsk Bedrift AS
</companyName>
</customerInformation>
<pickupAddress>
<street>
Testsvingen 12
</street>
<postalCode>
0263
</postalCode>
<email>
norsk.bedrift@example.com
</email>
<phoneNumber>
99999999
</phoneNumber>
<city>
OSLO
</city>
<messageToDriver>
Hentes på baksiden
</messageToDriver>
</pickupAddress>
<pickupDate>
2015-12-04
</pickupDate>
<pickupIsReadyAtTime>
12:28
</pickupIsReadyAtTime>
<pickupTimeZone>
Europe/Oslo
</pickupTimeZone>
<countryCode>
NO
</countryCode>
<service>CARGO</service>
<pickupDetails>
<numberOfPackages>
1
</numberOfPackages>
<weightInGrams>
70000
</weightInGrams>
<volumeInDm3>
40
</volumeInDm3>
</pickupDetails>
</pickupOrderRequest>
SOAP
https://api.bring.com/booking/api/ws
The SOAP Body follows the same XML Schema Definition (XSD) as the XML API.
The SOAP endpoint has the same operations as the endpoints listed above:
- list customers
- book shipments
- order pickups
WSDL
https://api.bring.com/booking/api/ws/booking-v1.wsdl
XSD
https://api.bring.com/booking/api/schema/booking-v1.xsd
Request parameters
HTTP header | Type | Description |
---|---|---|
Content-Type |
string |
Required Specify request format text/xml;charset=UTF-8 |
X-Bring-Client-URL |
string |
Required Identifying the web-page or application where the Bring API data is used |
X-MyBring-API-Key |
string |
Required Your user’s API key |
X-MyBring-API-Uid |
string |
Required Your Mybring login ID |
Request body
<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://www.bring.no/booking/">
<soapenv:Header/>
<soapenv:Body>
<bookingRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<schemaVersion>1</schemaVersion>
<consignments>
<consignment correlationId="INTERNAL-123456">
<shippingDateTime>2020-05-05T21:31:33.007+02:00</shippingDateTime>
<customerSpecifiedDeliveryDateTime>2020-05-11T00:00:00</customerSpecifiedDeliveryDateTime>
<parties>
<sender>
<name>Ola Nordmann</name>
<addressLine>Testsvingen 12</addressLine>
<postalCode>0263</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>1234</reference>
<additionalAddressInfo>Hentes på baksiden etter klokken to</additionalAddressInfo>
<contact>
<name>Trond Nordmann</name>
<email>trond@nordmanntest.no</email>
<phoneNumber>99999999</phoneNumber>
</contact>
</sender>
<recipient>
<name>Tore Mottaker</name>
<addressLine>Mottakerveien 14</addressLine>
<addressLine2>c/o Tina Mottaker</addressLine2>
<postalCode>0659</postalCode>
<city>OSLO</city>
<countryCode>no</countryCode>
<reference>43242</reference>
<additionalAddressInfo>Bruk ringeklokken</additionalAddressInfo>
<contact>
<name>Tore mottaker</name>
<email>tore@mottakertest.no</email>
<phoneNumber>88888888</phoneNumber>
</contact>
</recipient>
</parties>
<product>
<id>PA_DOREN</id>
<customerNumber>*************</customerNumber>
<additionalServices>
<additionalService>
<id>EVARSLING</id>
<email>sender@sender.com</email>
<mobile>12345</mobile>
</additionalService>
</additionalServices>
</product>
<packages>
<package correlationId="PACKAGE-123">
<weightInKg>1.1</weightInKg>
<goodsDescription>Testing equipment</goodsDescription>
<dimensions>
<heightInCm>13</heightInCm>
<widthInCm>23</widthInCm>
<lengthInCm>10</lengthInCm>
</dimensions>
</package>
</packages>
</consignment>
</consignments>
</bookingRequest>
</soapenv:Body>
</soapenv:Envelope>