Pickup API
The Pickup API is used to book ad hoc pickups.
Authentication
To integrate with the Bring APIs, you will need a Mybring user account with an API key. Information about prerequisites and authentication headers can be found on the general API Getting Started page. In addition to authentication, you need to be authorized.
Rate limiting
Clients exceeding a certain number of requests per second will be throttled, and the response will contain http status code 429. If you have a use case requiring rates above the limit, please contact developer-booking@bring.com for assistance.
Formats
REST JSON over HTTP is recommended for all new integrations. While we currently also support XML, this is very likely to be phased out in the future. Pickup endpoints will assume all requests are UTF-8 encoded.
Special topics
Endpoints
https://api.bring.com/pickup
Usage | Method | Endpoint |
---|---|---|
Order a pickup | POST |
/api/create
|
OpenAPI document
https://api.bring.com/pickup/api-docsOrder a pickup
https://api.bring.com/pickup/api/create
When booking 5100 Stykkgods til bedrift, pickup is added automatically, hence it is not needed in the API request.
Request
header parameters
-
X-Mybring-API-Uid
Required -
- Description
- Mybring login ID
- Type
- string
-
X-Mybring-API-Key
Required -
- Description
- Your user's API key
- Type
- string
-
X-Bring-Test-Indicator
-
- Description
- A boolean value indicating whether this is a test or not
- Type
- boolean
Body schema
-
countryCode
Required - Two-letter ISO-3166-1 country codestring
-
Required
- object
-
-
companyName
Required - string
-
customerNumber
Required - string
-
-
Required
- object
-
-
city
Required - string
-
contactName
- string
-
deliveryInstruction
- Delivery instruction to the driverstring
-
email
Required - stringMax length: 60
-
message
- Generic message to the driverstring
-
phoneNumber
Required - string
-
postalCode
Required - string
-
street
Required - string
-
-
pickupDate
Required - string
- object
-
-
numberOfPackages
Deprecated - This is deprecated. Use packages and count insteadinteger <int32>
-
numberOfPallets
Deprecated - This is deprecated. Use pallets and count insteadinteger <int32>
-
numberOfPostContainers
Deprecated - This is deprecated. Use postContainers and count insteadinteger <int32>
- object
-
-
count
Required - For giving number of packages. Applicable for parcel pickups in Norway and Nordics and cargo pickupinteger <int32>
-
volumeInDm3
- Applicable and required for cargo pickupnumber
-
weightInGrams
- Applicable for parcel pickups in Norway and Nordics and required for cargo pickupinteger <int32>
-
- object
-
-
count
Required - For giving number of pallets. Applicable for parcel pickups in Norway and Nordicsinteger <int32>
-
weightInGrams
- Applicable for parcel pickups in Norway and Nordicsinteger <int32>
-
- object
-
-
count
Required - For giving number of postContainers. Applicable for parcel pickups in Norwayinteger <int32>
-
weightInGrams
- Applicable for parcel pickups in Norwayinteger <int32>
-
-
volumeInDm3
Deprecated - This is deprecated. Use packages and volumeInDm3 insteadnumber
-
weightInGrams
- Applicable for pickup in Nordicsinteger <int32>
-
-
pickupIsReadyAtTime
- Currently not in usestring
-
pickupTimeZone
- string
-
service
Required - The pickup service you want to bookstring
- Enum
PARCEL
CARGO
-
testIndicator
Deprecated - Deprecated, use HTTP header instead. For test orders, set this to trueboolean
- object
-
-
countryCode
Required - Two-letter ISO-3166-1 country codestring
-
Required
- object
-
-
companyName
Required - string
-
customerNumber
Required - string
-
-
Required
- object
-
-
city
Required - string
-
contactName
- string
-
deliveryInstructionToDriver
- Delivery instruction to the driverstring
-
email
Required - stringMax length: 60
-
messageToDriver
- Generic message to the driverstring
-
phoneNumber
Required - string
-
postalCode
Required - string
-
street
Required - string
-
-
pickupDate
Required - string
- object
-
-
numberOfPackages
Deprecated - This is deprecated. Use packages and count insteadinteger <int32>
-
numberOfPallets
Deprecated - This is deprecated. Use pallets and count insteadinteger <int32>
-
numberOfPostContainers
Deprecated - This is deprecated. Use postContainers and count insteadinteger <int32>
- object
-
-
count
Required - For giving number of packages. Applicable for parcel pickups in Norway and Nordics and cargo pickupinteger <int32>
-
volumeInDm3
- Applicable and required for cargo pickupnumber
-
weightInGrams
- Applicable for parcel pickups in Norway and Nordics and required for cargo pickupinteger <int32>
-
- object
-
-
count
Required - For giving number of pallets. Applicable for parcel pickups in Norway and Nordicsinteger <int32>
-
weightInGrams
- Applicable for parcel pickups in Norway and Nordicsinteger <int32>
-
- object
-
-
count
Required - For giving number of postContainers. Applicable for parcel pickups in Norwayinteger <int32>
-
weightInGrams
- Applicable for parcel pickups in Norwayinteger <int32>
-
-
volumeInDm3
Deprecated - This is deprecated. Use packages and volumeInDm3 insteadnumber
-
weightInGrams
- Applicable for pickup in Nordicsinteger <int32>
-
-
pickupIsReadyAtTime
- Currently not in usestring
-
pickupTimeZone
- string
-
service
Required - The pickup service you want to bookstring
- Enum
PARCEL
CARGO
-
testIndicator
Deprecated - Deprecated, use HTTP header instead. For test orders, set this to trueboolean attribute
-
Responses
200 OK
Schema
- array of objects
-
code
- string
-
consignmentCorrelationId
- string
- array of objects
-
lang
- string
-
message
- string
-
-
packageCorrelationId
- string
-
uniqueId
- string
-
- object
-
-
earliestPickupDate
Required - string <date-time>
-
isoFormattedEarliestPickupDateTime
- ISO formatted datestring <date-time>
-
isoFormattedLatestPickupDateTime
- ISO formatted datestring <date-time>
-
latestPickupDate
- string <date-time>
-
packageNumber
- string
-
status
Required - string
-
url
- string
-
- object
-
- array wrapped
-
- object
-
-
code
Required - string
-
consignmentCorrelationId
- string attribute
-
Required
- array wrapped
-
- object
-
-
lang
- string attribute
-
message
- string
-
-
packageCorrelationId
- string attribute
-
uniqueId
Required - string
-
- object
-
-
earliestPickupDate
Required - string <date-time>
-
isoFormattedEarliestPickupDateTime
- ISO formatted datestring <date-time>
-
isoFormattedLatestPickupDateTime
- ISO formatted datestring <date-time>
-
latestPickupDate
- string <date-time>
-
packageNumber
- string
-
status
Required - string
-
url
- string
-
400 Bad Request
Schema
- array of objects
- array of objects
-
code
- string
-
consignmentCorrelationId
- string
- array of objects
-
lang
- string
-
message
- string
-
-
packageCorrelationId
- string
-
uniqueId
- string
-
- object
-
-
earliestPickupDate
Required - string <date-time>
-
isoFormattedEarliestPickupDateTime
- ISO formatted datestring <date-time>
-
isoFormattedLatestPickupDateTime
- ISO formatted datestring <date-time>
-
latestPickupDate
- string <date-time>
-
packageNumber
- string
-
status
Required - string
-
url
- string
-
- array
-
- object
-
- array wrapped
-
- object
-
-
code
Required - string
-
consignmentCorrelationId
- string attribute
-
Required
- array wrapped
-
- object
-
-
lang
- string attribute
-
message
- string
-
-
packageCorrelationId
- string attribute
-
uniqueId
Required - string
-
- object
-
-
earliestPickupDate
Required - string <date-time>
-
isoFormattedEarliestPickupDateTime
- ISO formatted datestring <date-time>
-
isoFormattedLatestPickupDateTime
- ISO formatted datestring <date-time>
-
latestPickupDate
- string <date-time>
-
packageNumber
- string
-
status
Required - string
-
url
- string
-
Request examples
{
"countryCode": "NO",
"customerInformation": {
"companyName": "Norsk Bedrift AS",
"customerNumber": "*******"
},
"pickupAddress": {
"city": "OSLO",
"email": "norsk.bedrift@example.com",
"message": "Hentes på baksiden",
"phoneNumber": "+4712345678",
"postalCode": "0263",
"street": "Testsvingen 12"
},
"pickupDate": "2015-12-03",
"pickupDetails": {
"packages": {
"count": 2,
"volumeInDm3": 40,
"weightInGrams": 1000
}
},
"pickupIsReadyAtTime": null,
"pickupTimeZone": "Europe/Oslo",
"service": "CARGO",
"testIndicator": true
}
{
"countryCode": "SE",
"customerInformation": {
"companyName": "Svensk Bedrift AS",
"customerNumber": "************"
},
"pickupAddress": {
"city": "Stockholm",
"email": "svensk.bedrift@example.com",
"message": "Hentes på baksiden",
"phoneNumber": "+46781234567",
"postalCode": "12000",
"street": "Testsvingen 12"
},
"pickupDate": "2015-12-03",
"pickupDetails": {
"packages": {
"count": 2
},
"pallets": {
"count": 1
},
"weightInGrams": 15000
},
"pickupIsReadyAtTime": null,
"pickupTimeZone": null,
"service": "PARCEL",
"testIndicator": true
}
{
"countryCode": "NO",
"customerInformation": {
"companyName": "Norsk Bedrift AS",
"customerNumber": "************"
},
"pickupAddress": {
"city": "OSLO",
"email": "norsk.bedrift@example.com",
"message": "Hentes på baksiden",
"phoneNumber": "+4712345678",
"postalCode": "0263",
"street": "Testsvingen 12"
},
"pickupDate": "2015-12-03",
"pickupDetails": {
"packages": {
"count": 2,
"weightInGrams": 1000
},
"pallets": {
"count": 1,
"weightInGrams": 15000
},
"postContainers": {
"count": 0
}
},
"pickupIsReadyAtTime": null,
"pickupTimeZone": null,
"service": "PARCEL",
"testIndicator": true
}
<?xml version="1.0" encoding="UTF-8"?>
<pickupOrderRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<countryCode>NO</countryCode>
<customerInformation>
<companyName>Norsk Bedrift AS</companyName>
<customerNumber>*******</customerNumber>
</customerInformation>
<pickupAddress>
<city>OSLO</city>
<email>norsk.bedrift@example.com</email>
<messageToDriver>Hentes på baksiden</messageToDriver>
<phoneNumber>+4712345678</phoneNumber>
<postalCode>0263</postalCode>
<street>Testsvingen 12</street>
</pickupAddress>
<pickupDate>2015-12-03</pickupDate>
<pickupDetails>
<packages>
<count>2</count>
<volumeInDm3>40</volumeInDm3>
<weightInGrams>1000</weightInGrams>
</packages>
</pickupDetails>
<pickupTimeZone>Europe/Oslo</pickupTimeZone>
<service>CARGO</service>
</pickupOrderRequest>
<?xml version="1.0" encoding="UTF-8"?>
<pickupOrderRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<countryCode>SE</countryCode>
<customerInformation>
<companyName>Svensk Bedrift AS</companyName>
<customerNumber>************</customerNumber>
</customerInformation>
<pickupAddress>
<city>Stockholm</city>
<email>svensk.bedrift@example.com</email>
<messageToDriver>Hentes på baksiden</messageToDriver>
<phoneNumber>+46781234567</phoneNumber>
<postalCode>12000</postalCode>
<street>Testsvingen 12</street>
</pickupAddress>
<pickupDate>2015-12-03</pickupDate>
<pickupDetails>
<packages>
<count>2</count>
</packages>
<pallets>
<count>1</count>
</pallets>
<weightInGrams>15000</weightInGrams>
</pickupDetails>
<service>PARCEL</service>
</pickupOrderRequest>
<?xml version="1.0" encoding="UTF-8"?>
<pickupOrderRequest xmlns="http://www.bring.no/booking/" testIndicator="true">
<countryCode>NO</countryCode>
<customerInformation>
<companyName>Norsk Bedrift AS</companyName>
<customerNumber>************</customerNumber>
</customerInformation>
<pickupAddress>
<city>OSLO</city>
<email>norsk.bedrift@example.com</email>
<messageToDriver>Hentes på baksiden</messageToDriver>
<phoneNumber>+4712345678</phoneNumber>
<postalCode>0263</postalCode>
<street>Testsvingen 12</street>
</pickupAddress>
<pickupDate>2015-12-03</pickupDate>
<pickupDetails>
<packages>
<count>2</count>
<weightInGrams>1000</weightInGrams>
</packages>
<pallets>
<count>1</count>
<weightInGrams>15000</weightInGrams>
</pallets>
<postContainers>
</postContainers>
</pickupDetails>
<service>PARCEL</service>
</pickupOrderRequest>
Response examples
Pickup Order Response
{
"errors": null,
"pickupConfirmation": {
"earliestPickupDate": 1720159200000,
"isoFormattedEarliestPickupDateTime": "2024-05-27T08:00:00.000+00:00",
"isoFormattedLatestPickupDateTime": "2024-05-27T16:00:00.000+00:00",
"latestPickupDate": 1720188000000,
"packageNumber": "123456789012345678",
"status": "OK",
"url": "https://www.mybring.com/order/pickup/receipt/xxxxxxxxx"
}
}
Pickup Order Response
<pickupOrderResponse>
<pickupConfirmation>
<status>OK</status>
<earliestPickupDate>2024-05-27T08:00:00+00:00</earliestPickupDate>
<latestPickupDate>2024-05-27T16:00:00+00:00</latestPickupDate>
<url>https://www.mybring.com/order/pickup/receipt/xxxxxxxxx</url>
<packageNumber>123456789012345678</packageNumber>
</pickupConfirmation>
</pickupOrderResponse>
{
"errors": [
{
"code": "BOOK-INPUT-022",
"messages": [
{
"lang": "en",
"message": "Illegal product for country"
}
],
"uniqueId": "a1298c95-699e-4e50-b70a-1b81a76c2418"
}
]
}
{
"errors": [
{
"code": "BOOK-INPUT-028",
"messages": [
{
"lang": "en",
"message": "Invalid country code"
}
],
"uniqueId": "1a684005-4c4b-4d01-a833-8e2c0ca31222"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-012",
"messages": [
{
"lang": "en",
"message": "Selected pickup point should be in recipient country"
}
],
"uniqueId": "d16b1365-58dc-4ce9-8597-037d3a53bb25"
}
]
}
{
"errors": [
{
"code": "BOOK-INPUT-020",
"messages": [
{
"lang": "en",
"message": "Invalid product ID"
}
],
"uniqueId": "4c46f91e-0d79-4eac-a168-a416bb45b025"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-007",
"messages": [
{
"lang": "en",
"message": "Pickup date must be in the future"
}
],
"uniqueId": "7f1dce42-bd81-4c3a-ba88-b0471f0ac64f"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-001",
"messages": [
{
"lang": "en",
"message": "Error with input in pickupOrder"
}
],
"uniqueId": "1e6a3cbb-a3cd-4606-95c0-1f05ee1ce714"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-003",
"messages": [
{
"lang": "en",
"message": "Cargo customer must provide cargoInformation element. Parcel customer must provide parcelsInformation element"
}
],
"uniqueId": "59034af5-0171-400f-adac-e9d99c492a9e"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-015",
"messages": [
{
"lang": "en",
"message": "Chargeable weight must be below groupage max weight limit"
}
],
"uniqueId": "7a8d6c69-d0a4-4a48-aca2-e177c685340c"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-006",
"messages": [
{
"lang": "en",
"message": "You must specify pickupDate element yyyy-MM-dd"
}
],
"uniqueId": "5dfcb390-409a-4c29-ae52-e846d0271195"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-016",
"messages": [
{
"lang": "en",
"message": "Must either have weightInGrams in pickupDetails, or on package or pallets level. Can not have both"
}
],
"uniqueId": "b971f7d1-cc67-4713-943b-412a23ab9420"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-002",
"messages": [
{
"lang": "en",
"message": "Postal code must be given and be valid"
}
],
"uniqueId": "1dec8ddd-8412-4e56-9948-8efb92ea001a"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-005",
"messages": [
{
"lang": "en",
"message": "You must specify pickupIsReadyAtTime element HH:mm:ss"
}
],
"uniqueId": "56b161d6-09e3-41b8-a013-a5f53e372402"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-008",
"messages": [
{
"lang": "en",
"message": "weightInGrams is required, and must be an integer larger than zero"
}
],
"uniqueId": "c29a312f-2aec-4b43-ad54-e307f3b98b03"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-010",
"messages": [
{
"lang": "en",
"message": "Country code is required"
}
],
"uniqueId": "4cdd5dc6-feef-49b7-9db2-7ad744bdeb8a"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-009",
"messages": [
{
"lang": "en",
"message": "Must be an integer larger than zero"
}
],
"uniqueId": "6a06b59f-320b-481d-9d75-7aea755be870"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-004",
"messages": [
{
"lang": "en",
"message": "This customer number cannot be used to order Pickup"
}
],
"uniqueId": "c46018ec-57f9-48be-95b7-e4deff75c1b3"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-013",
"messages": [
{
"lang": "en",
"message": "Combination pickupIsReadyAtTime and pickupDate must be in the future"
}
],
"uniqueId": "76f7391b-5eb0-4f1e-aade-8f502be2dc75"
}
]
}
{
"errors": [
{
"code": "PICKUP-INTERNAL-001",
"messages": [
{
"lang": "en",
"message": "An unexpected error occured"
}
],
"uniqueId": "14e79fd9-13c8-4581-ab33-72cebaa92df9"
}
]
}
{
"errors": [
{
"code": "PICKUP-INPUT-011",
"messages": [
{
"lang": "en",
"message": "Both Pickup Point ID and Country Code is Required"
}
],
"uniqueId": "0056a49a-4086-4ef4-ba98-144af46ea682"
}
]
}
{
"errors": [
{
"code": "BOOK-AUTHORIZATION-001",
"messages": [
{
"lang": "en",
"message": "Your user is not authorized to perform this action"
}
],
"uniqueId": "d66771ab-2e0b-44bd-b02d-a59178334a19"
}
]
}
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- Example cannot be generated; root element name is undefined -->