Skip to main content

Tracking API

: Tracking API - Deprecation of Unauthenticated requests

Starting from May 13th, unauthenticated requests will no longer have access to the Tracking API. Previously, we implemented rate limiting measures. Read here on how to make authenticated requests.

If you see following error message that means you are not sending authenticated requests.

401 - Unathorized. The Tracking API no longer supports unauthenticated requests. Make sure your requests are authenticated. Read more about this on our Bring developer site. https://developer.bring.com/api/tracking/

: Tracking API – Starting from 2nd of May, 2024, we will reject browser calls associated with a customer number to enhance security.

We have discovered some API users exposing username and API key openly in the source code of their website. This means that this information is accessible to anyone with a certain level of technical expertise. This poses a security risk as it allows unauthorized access to information about agreements with Posten Bring, as well as GDPR-sensitive customer data.

To address this, we strongly recommend that you call our Tracking API from the backend instead of via the browser. This way, this information will not be exposed. We advise you to promptly delete the current API key and generate a new one here: https://www.mybring.com/useradmin/account/settings/api

If it is not feasible to call our APIs from the backend and you are entirely dependent on doing so via the browser, we recommend creating a new user account not associated with your customer numbers. You can create such an account here: https://www.mybring.com/useradmin/account/settings/api

Please note that starting from May 2, 2024, we will reject browser calls associated with a customer number to enhance security.

The Tracking API will no longer support unauthenticated requests from 13.05.2024

Starting from May 13th, unauthenticated requests will no longer have access to the Tracking API. Previously, we implemented rate limiting measures. Read here on how to make authenticated requests.

If you see following error message that means you are not sending authenticated requests.

401 - Unathorized. The Tracking API no longer supports unauthenticated requests. Make sure your requests are authenticated. Read more about this on our Bring developer site. https://developer.bring.com/api/tracking/

The Tracking API will start rate limiting unauthenticated requests from 15.08.2023

Our customers are increasingly demanding new functionality and solutions that are easy to use. To meet these expectations, we must know which customers and partners are using our APIs and how they are using them. To further develop the value proposition of our Tracking API, the solution will require authentication. Read here on how to make authenticated requests.

From 15 August 2023, we will start rate limiting the requests.

If you see following error message that means you are being rate limited, and you should start using authenticated requests.

429 - Too many requests. We are now rate limiting our unauthenticated users, to prevent this make sure your requests are authenticated. Read more about this on our Bring developer site. https://developer.bring.com/api/tracking/

Deprecating v1 version of Tracking API - 01.08.2022Starting 1 August 2022, Tracking API version v1 will be deprecated and the requests will be automatically forwarded to the latest version, v2. It is not a breaking change. In the new version you will have access to many more fields.
Removed event statuses from open tracking - 22.06.2022The event statuses ARRIVED_COLLECTION and ARRIVED_DELIVERY are not valid anymore, and therefore have been removed from the Tracking API.

The Tracking API provides the opportunity to track shipments by reference, package or shipment number. It is an easy way to get shipment details and events and make them available for customers. The information available in this API is the same that is publicly available from the Tracking website.

Authentication

By using authenticated Tracking API requests, you can get more information such as price, name, address and signatures for proof of delivery. The rate limits are also less strict.

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.

The Tracking API will stop being open to anyone and start requiring users to be authenticated. We have already started rate limiting unauthenticated users, which will result in unauthenticated users getting a lower limit on their request and in the end not being able to use our API.

Formats

REST XML/JSON/JSONP over HTTP. We follow the JSON API specification with one exception: we allow media type to be specified as application/json instead of application/vnd.api+json.

Versioning

Latest Tracking API version: v2

We encourage you to always use the latest version of our API. We keep the previous version for some time so that you will get enough time to convert your application. This API supports versioning by two means.

Select version by request-header

Use the normal URL but add the following request-header:

Header Example
api-version 2

Example request

curl -H "api-version: 2" https://api.bring.com/tracking/api/tracking.json?q=TESTPACKAGEATPICKUPPOINT

Select version by URL

Use the normal URL, but add {v2} to the URL. Example:

Application URL example
Tracking https://api.bring.com/tracking/api/v2/tracking.json?q=TESTPACKAGEATPICKUPPOINT

Example request

curl -v https://api.bring.com/tracking/api/v2/tracking.json?q=TESTPACKAGEATPICKUPPOINT

Events Description

A parcel has a number of events connected to it during its travel. Here are a list of current event statuses that can be returned.

Event Description
ATTEMPTED_DELIVERY The package has been attempted delivered at the door. Depending on the service it will be tried again or sent to closest pickup point.
CUSTOMS Package is in customs clearance.
COLLECTED The parcel has been collected at pickup address.
DELIVERED Package has been delivered.
DELIVERED_SENDER Package has been returned to the sender
DELIVERY_CANCELLED Home delivery has been cancelled by the customer.
DELIVERY_CHANGED Date for Home delivery has been changed by customer.
DELIVERY_ORDERED Home delivery has been ordered
DEVIATION Deviation in production. Something wrong has happened and there is a probability for delay.
HANDED_IN Package has been handed in to Bring.
INTERNATIONAL Package has been sent from origin country or arrived at destination country.
IN_TRANSIT Package is in transit.
NOTIFICATION_SENT Notification for this package has been sent by sms, push and/or mail. This can be informational notifications and action notification like pickup notice.
PRE_NOTIFIED EDI message for the package has been received by Bring.
READY_FOR_PICKUP Package has arrived at pickup point.
RETURN The package is on its way back to the sender.
TRANSPORT_TO_RECIPIENT Package has been loaded for delivery to the recipient.
TERMINAL The package is now registered/arrived at inbound/outbound storage terminal
UNKNOWN Represents unknown / undefined events

Verification

You can verify that your request was used correctly by certifying that the response contains an element based on the request type:

URI request Response type Example
tracking.json application/json; charset=utf-8 {"apiVersion": "2"}
tracking.xml application/xml;charset=utf-8 <ApiVersion>2</ApiVersion>

Endpoints

Base URL
https://api.bring.com/tracking
Usage Method Endpoint
Get information about a shipment GET /api/{version}/tracking.{extension}

Get information about a shipment

get
                  https://api.bring.com/tracking/api/{version}/tracking.{extension}
                

Get information about an existing shipment based on a tracking number, shipment number or reference.

Request

header parameters

X-Mybring-API-Uid
Description
Mybring login ID
Type
string
Example
john.doe@example.com
X-Mybring-API-Key
Description
Your user's API key
Type
string
Example
1234abc-abcd-1234-5678-abcd1234abcd
X-Bring-Client-URL
Description
A URL identifying where you're using the APIs
Type
string
Example
https://example.com/
api-version
Type
string

query parameters

q
Description
A query parameter where you enter the tracking number or reference string to be fetched. Note that our examples here differ from the norm by being all characters, usually a Posten/Bring generated tracking number is all digits.
Type
string
Examples
Package delivered to customer
q=TESTPACKAGEDELIVERED
Package loaded for delivery
q=TESTPACKAGELOADEDFORDELIVERY
Unreceived package, with notification regarding EDI
q=TESTPACKAGEEDI
Waiting at Pickup Point
q=TESTPACKAGEATPICKUPPOINT
callback
Description
If provided, wraps the response in a JSONP object with the provided callback name
Type
string
Example
callback=callback
extraInfo
Type
string
Default
false

path parameters

version
Required
Type
string
extension
Required
Type
string

Responses

200 OK

Schema

apiVersion
Required
string
array of objects
Schema (oneOf)
array of objects
actionType
string
actionURL
string
consignmentId
string
contractPricePackageCount
string
currencyCode
string
isLoggedInSenderOrReceiver
boolean
isPickupNoticeAvailable
boolean
listPricePackageCount
string
numberOfConsignmentItems
integer <int32>
array of objects
array of objects
amount
string
currencyCode
string
description
string
id
string
longDescription
string
brand
string
contractPrice
string
currencyCode
string
dateOfEstimatedDelivery
string
dateOfReturn
string
array of objects
text
string
type
string
url
string <url>
object
endTime
string
startTime
string
eventSet
array of objects
expectedPickupUnitId
string
expectedPickupUnitName
string
expectedPickupUnitURL
string
heightInCm
integer <int32>
isLoggedInSenderOrReceiver
boolean
lengthInCm
integer <int32>
listPrice
string
packageNumber
string
pickupCode
string
previousPackageNumber
string
productCode
string
productLink
string
productName
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientEmailAddress
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientMobileNumber
string
recipientName
string
object
caseId
Required
string
hasBeenRequested
Required
boolean
requestedPackageOn
Required
string
userEmail
Required
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderEmailAddress
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderMobileNumber
string
senderName
string
shelfNumber
string
statusDescription
string
thirdPartyMobileNumber
string
volumeInDm3
number <double>
weightInKgs
number <double>
widthInCm
integer <int32>
previousConsignmentId
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientCustomerMasterNumber
string
recipientCustomerNumber
string
recipientCustomerType
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientName
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderCustomerMasterNumber
string
senderCustomerNumber
string
senderCustomerType
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderLogo
string
senderName
string
senderReference
string
totalContractPrice
string
totalListPrice
string
totalVolumeInDm3
Required
number <double>
totalWeightInKgs
Required
number <double>
object
code
integer <int32>
message
string
system
string
object
ApiVersion
Required
string
array
object
Schema (oneOf)
array
object
ActionType
Required
string
ActionURL
Required
string
consignmentId
string attribute
contractPricePackageCount
string
CurrencyCode
string
isLoggedInSenderOrReceiver
boolean
IsPickupNoticeAvailable
boolean
listPricePackageCount
string
NumberOfConsignmentItems
integer <int32>
array wrapped
object
array wrapped
object
Amount
Required
string
CurrencyCode
Required
string
Description
Required
string
Id
Required
string
LongDescription
string
Brand
Required
string
ContractPrice
string
CurrencyCode
string
EstimatedDeliveryDate
string
LastRetrievalDate
string
array wrapped
object
Text
string
Type
string
Url
string <url>
object
endTime
string
startTime
string
array wrapped
EventType
object
expectedPickupUnitId
string
expectedPickupUnitName
string
expectedPickupUnitURL
string
Height
Required
integer <int32>
isLoggedInSenderOrReceiver
boolean
Length
Required
integer <int32>
ListPrice
string
packageNumber
string attribute
PickupCode
string
previousPackageNumber
string attribute
ProductCode
Required
string
ProductLink
string
ProductName
Required
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientEmailAddress
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientMobileNumber
string
RecipientName
string
object
caseId
Required
string
hasBeenRequested
Required
boolean
RequestedPackageOn
Required
string
UserEmail
Required
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderEmailAddress
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderMobileNumber
string
SenderName
string
ShelfNumber
string
StatusDescription
Required
string
ThirdPartyMobileNumber
string
Volume
Required
number <double>
Weight
Required
number <double>
Width
Required
integer <int32>
previousConsignmentId
string attribute
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientCustomerMasterNumber
string
RecipientCustomerNumber
string
RecipientCustomerType
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientName
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderCustomerMasterNumber
string
SenderCustomerNumber
string
SenderCustomerType
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderLogo
string
SenderName
string
SenderReference
string
TotalContractPrice
string
TotalListPrice
string
TotalVolume
Required
number <double>
TotalWeight
Required
number <double>
object
code
integer <int32>
message
string
system
string
400 Bad Request

Schema

apiVersion
Required
string
array of objects
Schema (oneOf)
array of objects
actionType
string
actionURL
string
consignmentId
string
contractPricePackageCount
string
currencyCode
string
isLoggedInSenderOrReceiver
boolean
isPickupNoticeAvailable
boolean
listPricePackageCount
string
numberOfConsignmentItems
integer <int32>
array of objects
array of objects
amount
string
currencyCode
string
description
string
id
string
longDescription
string
brand
string
contractPrice
string
currencyCode
string
dateOfEstimatedDelivery
string
dateOfReturn
string
array of objects
text
string
type
string
url
string <url>
object
endTime
string
startTime
string
eventSet
array of objects
expectedPickupUnitId
string
expectedPickupUnitName
string
expectedPickupUnitURL
string
heightInCm
integer <int32>
isLoggedInSenderOrReceiver
boolean
lengthInCm
integer <int32>
listPrice
string
packageNumber
string
pickupCode
string
previousPackageNumber
string
productCode
string
productLink
string
productName
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientEmailAddress
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientMobileNumber
string
recipientName
string
object
caseId
Required
string
hasBeenRequested
Required
boolean
requestedPackageOn
Required
string
userEmail
Required
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderEmailAddress
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderMobileNumber
string
senderName
string
shelfNumber
string
statusDescription
string
thirdPartyMobileNumber
string
volumeInDm3
number <double>
weightInKgs
number <double>
widthInCm
integer <int32>
previousConsignmentId
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientCustomerMasterNumber
string
recipientCustomerNumber
string
recipientCustomerType
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientName
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderCustomerMasterNumber
string
senderCustomerNumber
string
senderCustomerType
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderLogo
string
senderName
string
senderReference
string
totalContractPrice
string
totalListPrice
string
totalVolumeInDm3
Required
number <double>
totalWeightInKgs
Required
number <double>
object
code
integer <int32>
message
string
system
string
object
ApiVersion
Required
string
array
object
Schema (oneOf)
array
object
ActionType
Required
string
ActionURL
Required
string
consignmentId
string attribute
contractPricePackageCount
string
CurrencyCode
string
isLoggedInSenderOrReceiver
boolean
IsPickupNoticeAvailable
boolean
listPricePackageCount
string
NumberOfConsignmentItems
integer <int32>
array wrapped
object
array wrapped
object
Amount
Required
string
CurrencyCode
Required
string
Description
Required
string
Id
Required
string
LongDescription
string
Brand
Required
string
ContractPrice
string
CurrencyCode
string
EstimatedDeliveryDate
string
LastRetrievalDate
string
array wrapped
object
Text
string
Type
string
Url
string <url>
object
endTime
string
startTime
string
array wrapped
EventType
object
expectedPickupUnitId
string
expectedPickupUnitName
string
expectedPickupUnitURL
string
Height
Required
integer <int32>
isLoggedInSenderOrReceiver
boolean
Length
Required
integer <int32>
ListPrice
string
packageNumber
string attribute
PickupCode
string
previousPackageNumber
string attribute
ProductCode
Required
string
ProductLink
string
ProductName
Required
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientEmailAddress
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientMobileNumber
string
RecipientName
string
object
caseId
Required
string
hasBeenRequested
Required
boolean
RequestedPackageOn
Required
string
UserEmail
Required
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderEmailAddress
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderMobileNumber
string
SenderName
string
ShelfNumber
string
StatusDescription
Required
string
ThirdPartyMobileNumber
string
Volume
Required
number <double>
Weight
Required
number <double>
Width
Required
integer <int32>
previousConsignmentId
string attribute
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientCustomerMasterNumber
string
RecipientCustomerNumber
string
RecipientCustomerType
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientName
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderCustomerMasterNumber
string
SenderCustomerNumber
string
SenderCustomerType
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderLogo
string
SenderName
string
SenderReference
string
TotalContractPrice
string
TotalListPrice
string
TotalVolume
Required
number <double>
TotalWeight
Required
number <double>
object
code
integer <int32>
message
string
system
string
404 Not Found

Schema

apiVersion
Required
string
array of objects
Schema (oneOf)
array of objects
actionType
string
actionURL
string
consignmentId
string
contractPricePackageCount
string
currencyCode
string
isLoggedInSenderOrReceiver
boolean
isPickupNoticeAvailable
boolean
listPricePackageCount
string
numberOfConsignmentItems
integer <int32>
array of objects
array of objects
amount
string
currencyCode
string
description
string
id
string
longDescription
string
brand
string
contractPrice
string
currencyCode
string
dateOfEstimatedDelivery
string
dateOfReturn
string
array of objects
text
string
type
string
url
string <url>
object
endTime
string
startTime
string
eventSet
array of objects
expectedPickupUnitId
string
expectedPickupUnitName
string
expectedPickupUnitURL
string
heightInCm
integer <int32>
isLoggedInSenderOrReceiver
boolean
lengthInCm
integer <int32>
listPrice
string
packageNumber
string
pickupCode
string
previousPackageNumber
string
productCode
string
productLink
string
productName
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientEmailAddress
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientMobileNumber
string
recipientName
string
object
caseId
Required
string
hasBeenRequested
Required
boolean
requestedPackageOn
Required
string
userEmail
Required
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderEmailAddress
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderMobileNumber
string
senderName
string
shelfNumber
string
statusDescription
string
thirdPartyMobileNumber
string
volumeInDm3
number <double>
weightInKgs
number <double>
widthInCm
integer <int32>
previousConsignmentId
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientCustomerMasterNumber
string
recipientCustomerNumber
string
recipientCustomerType
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientName
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderCustomerMasterNumber
string
senderCustomerNumber
string
senderCustomerType
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderLogo
string
senderName
string
senderReference
string
totalContractPrice
string
totalListPrice
string
totalVolumeInDm3
Required
number <double>
totalWeightInKgs
Required
number <double>
object
code
integer <int32>
message
string
system
string
object
ApiVersion
Required
string
array
object
Schema (oneOf)
array
object
ActionType
Required
string
ActionURL
Required
string
consignmentId
string attribute
contractPricePackageCount
string
CurrencyCode
string
isLoggedInSenderOrReceiver
boolean
IsPickupNoticeAvailable
boolean
listPricePackageCount
string
NumberOfConsignmentItems
integer <int32>
array wrapped
object
array wrapped
object
Amount
Required
string
CurrencyCode
Required
string
Description
Required
string
Id
Required
string
LongDescription
string
Brand
Required
string
ContractPrice
string
CurrencyCode
string
EstimatedDeliveryDate
string
LastRetrievalDate
string
array wrapped
object
Text
string
Type
string
Url
string <url>
object
endTime
string
startTime
string
array wrapped
EventType
object
expectedPickupUnitId
string
expectedPickupUnitName
string
expectedPickupUnitURL
string
Height
Required
integer <int32>
isLoggedInSenderOrReceiver
boolean
Length
Required
integer <int32>
ListPrice
string
packageNumber
string attribute
PickupCode
string
previousPackageNumber
string attribute
ProductCode
Required
string
ProductLink
string
ProductName
Required
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientEmailAddress
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientMobileNumber
string
RecipientName
string
object
caseId
Required
string
hasBeenRequested
Required
boolean
RequestedPackageOn
Required
string
UserEmail
Required
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderEmailAddress
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderMobileNumber
string
SenderName
string
ShelfNumber
string
StatusDescription
Required
string
ThirdPartyMobileNumber
string
Volume
Required
number <double>
Weight
Required
number <double>
Width
Required
integer <int32>
previousConsignmentId
string attribute
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientCustomerMasterNumber
string
RecipientCustomerNumber
string
RecipientCustomerType
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientName
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderCustomerMasterNumber
string
SenderCustomerNumber
string
SenderCustomerType
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderLogo
string
SenderName
string
SenderReference
string
TotalContractPrice
string
TotalListPrice
string
TotalVolume
Required
number <double>
TotalWeight
Required
number <double>
object
code
integer <int32>
message
string
system
string
500 Internal Server Error

Schema

apiVersion
Required
string
array of objects
Schema (oneOf)
array of objects
actionType
string
actionURL
string
consignmentId
string
contractPricePackageCount
string
currencyCode
string
isLoggedInSenderOrReceiver
boolean
isPickupNoticeAvailable
boolean
listPricePackageCount
string
numberOfConsignmentItems
integer <int32>
array of objects
array of objects
amount
string
currencyCode
string
description
string
id
string
longDescription
string
brand
string
contractPrice
string
currencyCode
string
dateOfEstimatedDelivery
string
dateOfReturn
string
array of objects
text
string
type
string
url
string <url>
object
endTime
string
startTime
string
eventSet
array of objects
expectedPickupUnitId
string
expectedPickupUnitName
string
expectedPickupUnitURL
string
heightInCm
integer <int32>
isLoggedInSenderOrReceiver
boolean
lengthInCm
integer <int32>
listPrice
string
packageNumber
string
pickupCode
string
previousPackageNumber
string
productCode
string
productLink
string
productName
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientEmailAddress
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientMobileNumber
string
recipientName
string
object
caseId
Required
string
hasBeenRequested
Required
boolean
requestedPackageOn
Required
string
userEmail
Required
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderEmailAddress
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderMobileNumber
string
senderName
string
shelfNumber
string
statusDescription
string
thirdPartyMobileNumber
string
volumeInDm3
number <double>
weightInKgs
number <double>
widthInCm
integer <int32>
previousConsignmentId
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientCustomerMasterNumber
string
recipientCustomerNumber
string
recipientCustomerType
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientName
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderCustomerMasterNumber
string
senderCustomerNumber
string
senderCustomerType
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderLogo
string
senderName
string
senderReference
string
totalContractPrice
string
totalListPrice
string
totalVolumeInDm3
Required
number <double>
totalWeightInKgs
Required
number <double>
object
code
integer <int32>
message
string
system
string
object
ApiVersion
Required
string
array
object
Schema (oneOf)
array
object
ActionType
Required
string
ActionURL
Required
string
consignmentId
string attribute
contractPricePackageCount
string
CurrencyCode
string
isLoggedInSenderOrReceiver
boolean
IsPickupNoticeAvailable
boolean
listPricePackageCount
string
NumberOfConsignmentItems
integer <int32>
array wrapped
object
array wrapped
object
Amount
Required
string
CurrencyCode
Required
string
Description
Required
string
Id
Required
string
LongDescription
string
Brand
Required
string
ContractPrice
string
CurrencyCode
string
EstimatedDeliveryDate
string
LastRetrievalDate
string
array wrapped
object
Text
string
Type
string
Url
string <url>
object
endTime
string
startTime
string
array wrapped
EventType
object
expectedPickupUnitId
string
expectedPickupUnitName
string
expectedPickupUnitURL
string
Height
Required
integer <int32>
isLoggedInSenderOrReceiver
boolean
Length
Required
integer <int32>
ListPrice
string
packageNumber
string attribute
PickupCode
string
previousPackageNumber
string attribute
ProductCode
Required
string
ProductLink
string
ProductName
Required
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientEmailAddress
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientMobileNumber
string
RecipientName
string
object
caseId
Required
string
hasBeenRequested
Required
boolean
RequestedPackageOn
Required
string
UserEmail
Required
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderEmailAddress
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderMobileNumber
string
SenderName
string
ShelfNumber
string
StatusDescription
Required
string
ThirdPartyMobileNumber
string
Volume
Required
number <double>
Weight
Required
number <double>
Width
Required
integer <int32>
previousConsignmentId
string attribute
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientCustomerMasterNumber
string
RecipientCustomerNumber
string
RecipientCustomerType
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientName
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderCustomerMasterNumber
string
SenderCustomerNumber
string
SenderCustomerType
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderLogo
string
SenderName
string
SenderReference
string
TotalContractPrice
string
TotalListPrice
string
TotalVolume
Required
number <double>
TotalWeight
Required
number <double>
object
code
integer <int32>
message
string
system
string
503 Service Unavailable

Schema

apiVersion
Required
string
array of objects
Schema (oneOf)
array of objects
actionType
string
actionURL
string
consignmentId
string
contractPricePackageCount
string
currencyCode
string
isLoggedInSenderOrReceiver
boolean
isPickupNoticeAvailable
boolean
listPricePackageCount
string
numberOfConsignmentItems
integer <int32>
array of objects
array of objects
amount
string
currencyCode
string
description
string
id
string
longDescription
string
brand
string
contractPrice
string
currencyCode
string
dateOfEstimatedDelivery
string
dateOfReturn
string
array of objects
text
string
type
string
url
string <url>
object
endTime
string
startTime
string
eventSet
array of objects
expectedPickupUnitId
string
expectedPickupUnitName
string
expectedPickupUnitURL
string
heightInCm
integer <int32>
isLoggedInSenderOrReceiver
boolean
lengthInCm
integer <int32>
listPrice
string
packageNumber
string
pickupCode
string
previousPackageNumber
string
productCode
string
productLink
string
productName
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientEmailAddress
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientMobileNumber
string
recipientName
string
object
caseId
Required
string
hasBeenRequested
Required
boolean
requestedPackageOn
Required
string
userEmail
Required
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderEmailAddress
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderMobileNumber
string
senderName
string
shelfNumber
string
statusDescription
string
thirdPartyMobileNumber
string
volumeInDm3
number <double>
weightInKgs
number <double>
widthInCm
integer <int32>
previousConsignmentId
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientCustomerMasterNumber
string
recipientCustomerNumber
string
recipientCustomerType
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
recipientName
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderCustomerMasterNumber
string
senderCustomerNumber
string
senderCustomerType
string
object
addressLine1
Required
string
addressLine2
Required
string
city
Required
string
country
Required
string
countryCode
Required
string
postalCode
Required
string
recipientId
Required
string
senderLogo
string
senderName
string
senderReference
string
totalContractPrice
string
totalListPrice
string
totalVolumeInDm3
Required
number <double>
totalWeightInKgs
Required
number <double>
object
code
integer <int32>
message
string
system
string
object
ApiVersion
Required
string
array
object
Schema (oneOf)
array
object
ActionType
Required
string
ActionURL
Required
string
consignmentId
string attribute
contractPricePackageCount
string
CurrencyCode
string
isLoggedInSenderOrReceiver
boolean
IsPickupNoticeAvailable
boolean
listPricePackageCount
string
NumberOfConsignmentItems
integer <int32>
array wrapped
object
array wrapped
object
Amount
Required
string
CurrencyCode
Required
string
Description
Required
string
Id
Required
string
LongDescription
string
Brand
Required
string
ContractPrice
string
CurrencyCode
string
EstimatedDeliveryDate
string
LastRetrievalDate
string
array wrapped
object
Text
string
Type
string
Url
string <url>
object
endTime
string
startTime
string
array wrapped
EventType
object
expectedPickupUnitId
string
expectedPickupUnitName
string
expectedPickupUnitURL
string
Height
Required
integer <int32>
isLoggedInSenderOrReceiver
boolean
Length
Required
integer <int32>
ListPrice
string
packageNumber
string attribute
PickupCode
string
previousPackageNumber
string attribute
ProductCode
Required
string
ProductLink
string
ProductName
Required
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientEmailAddress
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientMobileNumber
string
RecipientName
string
object
caseId
Required
string
hasBeenRequested
Required
boolean
RequestedPackageOn
Required
string
UserEmail
Required
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderEmailAddress
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderMobileNumber
string
SenderName
string
ShelfNumber
string
StatusDescription
Required
string
ThirdPartyMobileNumber
string
Volume
Required
number <double>
Weight
Required
number <double>
Width
Required
integer <int32>
previousConsignmentId
string attribute
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientCustomerMasterNumber
string
RecipientCustomerNumber
string
RecipientCustomerType
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
RecipientName
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderCustomerMasterNumber
string
SenderCustomerNumber
string
SenderCustomerType
string
object
AddressLine1
Required
string
AddressLine2
Required
string
City
Required
string
Country
Required
string
CountryCode
Required
string
PostalCode
Required
string
RecipientId
Required
string
SenderLogo
string
SenderName
string
SenderReference
string
TotalContractPrice
string
TotalListPrice
string
TotalVolume
Required
number <double>
TotalWeight
Required
number <double>
object
code
integer <int32>
message
string
system
string

Response examples

{
  "apiVersion": "2",
  "consignmentSet": [
    {
      "consignmentId": "SHIPMENTNUMBER",
      "isLoggedInSenderOrReceiver": false,
      "isPickupNoticeAvailable": false,
      "packageSet": [
        {
          "additionalServiceSet": [
            {
              "amount": "",
              "currencyCode": "",
              "description": "eAdvising",
              "id": "1091",
              "longDescription": "Delivery advising will be sent via sms +4700000000 and/or e-mail"
            }
          ],
          "brand": "POSTEN",
          "descriptions": [],
          "eventSet": [
            {
              "city": "",
              "consignmentEvent": false,
              "country": "",
              "countryCode": "",
              "displayTime": "",
              "insignificant": false,
              "postalCode": "",
              "recipientSignature": {
                "linkToImage": "api/parcel-hub/signature?consignmentItemNumber=TESTPACKAGEDELIVERED&imageName=imageName",
                "name": "HOME OWNER"
              },
              "unitId": "971190",
              "unitType": "BRING"
            },
            {
              "city": "OSLO",
              "consignmentEvent": false,
              "country": "Norway",
              "countryCode": "NO",
              "displayTime": "",
              "insignificant": false,
              "postalCode": "0001",
              "recipientSignature": {
                "name": ""
              },
              "unitId": "971190",
              "unitType": "BRING"
            },
            {
              "city": "OSLO",
              "consignmentEvent": false,
              "country": "Norway",
              "countryCode": "NO",
              "displayTime": "",
              "insignificant": false,
              "postalCode": "0024",
              "recipientSignature": {
                "name": ""
              },
              "unitId": "032850",
              "unitType": "BRING"
            }
          ],
          "heightInCm": 29,
          "isLoggedInSenderOrReceiver": false,
          "lengthInCm": 41,
          "packageNumber": "TESTPACKAGEDELIVERED",
          "previousPackageNumber": "",
          "productCode": "1736",
          "productLink": "http://www.bring.no/english/shortcuts/1736",
          "productName": "HOME DELIVERY",
          "statusDescription": "",
          "volumeInDm3": 45.2,
          "weightInKgs": 16.5,
          "widthInCm": 38
        }
      ],
      "previousConsignmentId": "",
      "recipientCustomerMasterNumber": "",
      "recipientCustomerNumber": "",
      "recipientCustomerType": "",
      "senderCustomerMasterNumber": "",
      "senderCustomerNumber": "",
      "senderCustomerType": "",
      "senderReference": "",
      "totalVolumeInDm3": 45.2,
      "totalWeightInKgs": 16.5
    }
  ]
}
comments powered by Disqus