Shipment API
Introduction
The Shipment API is a logged-in service that lets Mybring users (customers of Mybring) programatically create a instruction or a booking by invoking a Web Service by posting XML/JSON over HTTP.
The Shipment API uses Shipping Guide as the source for price and availability (when supported in the Shipping Guide) for the different products. We advise clients of the Shipment 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 Shipment 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.
We are continually rolling out support for more of Posten / Brings products and aim to support all available products in this API withing a short time. In addition to the documentation on this pages feel free to check out our swagger page for this API.
This API has similarities with the Booking API, but there are differences. Read more about the differences between the Booking API and the Shipment API.
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.
Overview of endpoints
Base URL
https://bapi.bring.com/shipment
Method | Endpoint | Usage |
---|---|---|
POST | /sendshipment?shipmentId={createShipmentId}&packageIds={createPackageId} | Request is used to either create, update or delete an instruction for Bring. |
POST | /sendbooking?shipmentId={createShipmentId}&packageIds={createPackageId} | Request is used to either create, update or delete an instruction for Bring. |
Create shipment
Sends a shipment consisting of one consignment, that must include at least one package (transportunit), from one sender to one receiver. The shipment might include additional information in regards to cash on delivery, dangerousgoods etc. If requested through the query parameteres the service will create shipmentid (for the whole shipment) in addition to package ids. The packageids will be returned in the order of the packages (ie. package 1 in the input wil have packageid 1 in returned array).
A valid combination of an additional party, with party type TransportCompany and a valid partyId and optionally subPartyId, and service is required. In addition there might be several valueadded services that can be added. Please refer to this link for both valid product codes/services and VASes.
The structure and most of the content will be validated.
URL
POST https://bapi.bring.com/shipment/sendshipment?shipmentId={createShipmentId}&packageIds={createPackageId}
Request parameters
URI param | Type | Description |
---|---|---|
createPackageId |
boolean |
Required If “true” the API will assign all package IDs for you and return them in the response. |
createShipmentId |
boolean |
Required If “true” the API will assign a shipment ID for you and return it in the response. |
Header name | Type | Description |
---|---|---|
Accept |
string |
Required
Specify response format (application/json, application/xml) Possible values:
|
Content-Type |
string |
Required
Specify request format (application/json, application/xml) Possible values:
|
Request body
Media type: application/json
Field | Type | Description |
---|---|---|
RequestDate
|
datetime |
RequiredDate and time for when the request was created Example: 2018-11-22T08:58:52 |
RequestVersion
|
number |
RequiredRequest version to use Example: 1 |
Shipment
|
object |
RequiredStructure for the shipment |
Field | Type | Description |
---|---|---|
AdditionalParty
|
array |
RequiredAdditionalparties for the shipment, repeatable. Refer to detailed instructions |
CashOnDelivery
|
object |
OptionalCash on delivery for the shipment |
DateAndTimes
|
array |
RequiredDate and times for the message, repeatable structure. Several dates are required |
DeliveryTerms
|
object |
OptionalTerms of delivery |
GoodsItem
|
array |
RequiredInformation about the goods being shipped |
ProductAndService
|
object |
RequiredProduct and service codes in addition to value added service structures |
Receiver
|
object |
RequiredStructure to hold receiver information |
Sender
|
object |
RequiredStructure to hold sender information |
ShipmentHeaders
|
object |
RequiredStructure that handles information for the whole shipment |
shipmentType
|
string |
RequiredType of shipment Possible values:
Example: Instruction |
updateIndicator
|
string |
RequiredIs this request an original, update or a deletion Possible values:
Example: Original |
Field | Type | Description |
---|---|---|
AdditionalReference
|
array |
OptionalAdditional references for the shipment as indicated by referenceType |
Dimensions
|
object |
OptionalDimensions required for the whole shipment |
ExchangableEquipment
|
object |
OptionalEquipment that can be reused, ie. pallets |
FreeText
|
array |
OptionalFreetext elements |
GrossVolume
|
object |
OptionalGross volume for the whole shipment |
GrossWeight
|
object |
OptionalGross weight for the whole shipment |
HazardPoints
|
integer |
OptionalSum of hazard points for the shipment Example: 22 |
LoadingMetres
|
number |
OptionalHow many metres of loading space required of a truck’s length Example: 12 |
NumberOfPackages
|
string |
RequiredTotal number of packages for the whole shipment across all goodsitems. Example: 3 |
PalletFootPrints
|
integer |
OptionalHow many pallet footprints are needed for the shipment Example: 3 |
ReceiversReference
|
string |
OptionalReceivers reference for the shipment Example: SOA-123222 |
SendersReference
|
string |
RequiredSenders reference for the shipment Example: SOA-123222 |
shipmentId
|
string |
RequiredId for the whole shipment, can be retrieved by the API Example: 70438101412575352 |
Field | Type | Description |
---|---|---|
DateTime
|
datetime |
RequiredDate and Time Example: 2018-11-22T08:58:52 |
subClass
|
string |
RequiredType of datetime Possible values:
Example: DocumentDate |
Field | Type | Description |
---|---|---|
Address
|
object |
OptionalParty address |
AddressLine
|
array |
RequiredAddress lines. The first line will be mapped to primary address line Example: Kong Oscars gate 12 |
CountryCode
|
string |
RequiredCountry code. Use valid country codes Example: NO |
StateOrRegion
|
string |
OptionalState or region, not in use in the nordic countries Example: Washington DC |
ContactName
|
string |
OptionalContact name for the party Example: Atle Thorstensen |
Email
|
string |
OptionalEmail Example: mail@mail.com |
Fax
|
string |
OptionalFax Example: +4712345678 |
MobilePhone
|
string |
OptionalMobile phone Example: +4712345678 |
Name
|
string |
OptionalParty name Example: Bring |
Phone
|
string |
OptionalPhone Example: +4712345678 |
Reference
|
array |
OptionalReference related to the party, can be used for account number of pallet system in Sweden for insatnce. |
ReferenceValue
|
string |
RequiredExtra Reference Example: 4440/0189981/WEJ |
referenceType
|
string |
RequiredReferenceType Possible values:
Example: TRANSPORT_DOCUMENT_NUMBER |
partyId
|
string |
OptionalIdentifier for the party Example: BEX |
subPartyId
|
string |
OptionalFurther identification of the party Example: GLW |
Field | Type | Description |
---|---|---|
Address
|
object |
OptionalParty address |
AddressLine
|
array |
RequiredAddress lines. The first line will be mapped to primary address line Example: Kong Oscars gate 12 |
CountryCode
|
string |
RequiredCountry code. Use valid country codes Example: NO |
StateOrRegion
|
string |
OptionalState or region, not in use in the nordic countries Example: Washington DC |
ContactName
|
string |
OptionalContact name for the party Example: Atle Thorstensen |
Email
|
string |
OptionalEmail Example: mail@mail.com |
Fax
|
string |
OptionalFax Example: +4712345678 |
MobilePhone
|
string |
OptionalMobile phone Example: +4712345678 |
Name
|
string |
OptionalParty name Example: Bring |
Phone
|
string |
OptionalPhone Example: +4712345678 |
Reference
|
array |
OptionalReference related to the party, can be used for account number of pallet system in Sweden for insatnce. |
ReferenceValue
|
string |
RequiredExtra Reference Example: 4440/0189981/WEJ |
referenceType
|
string |
RequiredReferenceType Possible values:
Example: TRANSPORT_DOCUMENT_NUMBER |
partyId
|
string |
OptionalIdentifier for the party Example: BEX |
subPartyId
|
string |
OptionalFurther identification of the party Example: GLW |
Field | Type | Description |
---|---|---|
Address
|
object |
OptionalParty address |
AddressLine
|
array |
RequiredAddress lines. The first line will be mapped to primary address line Example: Kong Oscars gate 12 |
CountryCode
|
string |
RequiredCountry code. Use valid country codes Example: NO |
StateOrRegion
|
string |
OptionalState or region, not in use in the nordic countries Example: Washington DC |
ContactName
|
string |
OptionalParty contact name Example: Ola Nordmann |
Email
|
string |
OptionalEmail Example: mail@mail.com |
Fax
|
string |
OptionalFax Example: +4712345678 |
MobilePhone
|
string |
OptionalMobile phone Example: +4712345678 |
Name
|
string |
OptionalParty name Example: Rogers antistatiske overledninger |
Phone
|
string |
OptionalPhone Example: +4712345678 |
Reference
|
array |
OptionalFuther references related to the party Example: SOA-121232332-AN |
ReferenceValue
|
string |
RequiredExtra Reference Example: 4440/0189981/WEJ |
referenceType
|
string |
RequiredReferenceType Possible values:
Example: TRANSPORT_DOCUMENT_NUMBER |
partyId
|
string |
RequiredIdentifier for the party Example: BEX |
subClass
|
string |
RequiredType of Party Possible values:
Example: DeliveryParty |
subPartyId
|
string |
OptionalFurther identification for the party Example: GLW |
Field | Type | Description |
---|---|---|
AdditionalService
|
array |
OptionalAdditional service codes |
AdditionalServiceCode
|
string |
RequiredThe additional service code for the product Example: EVARSLING |
ServiceRequirements
|
array |
RequiredSome AdditionalServiceCodes / valueadded service might require extra information |
NatureOfCargo
|
string |
OptionalIndicates if the cargo is out of bound of general expected parameters, dangerous goods or out og gauge Example: 11 |
ProductCode
|
string |
RequiredProductcode for shipment, refer to documentation for valid productcodes for this service Example: COURIER_1H |
TariffReference
|
string |
OptionalAdditional information about the price of the cargo in connection with the service Possible values:
Example: GNCG |
Field | Type | Description |
---|---|---|
ConditionCode
|
string |
RequiredThe actual terms for the chosen deliverytermstype Example: EXW |
Location
|
object |
OptionalThe location where the given deliveryterms (condition) applies (to or from given conditioncode.) |
City
|
string |
RequiredCity where the deliveryterms are valid to or from Example: Bergen |
CountryCode
|
string |
RequiredCountry where the deliveryterms ar valid to or from Example: NO |
termsType
|
string |
RequiredTerms valid for this shipment Possible values:
Example: Incoterms |
Field | Type | Description |
---|---|---|
Amount
|
object |
OptionalAmount expected on delivery Example: 123450 |
currencyCode
|
string |
RequiredCurrencycode, valid currency codes allowed Example: NOK |
ControlDigit
|
integer |
OptionalControl digit for incoming amount when there is specified a KID number (norwegian only) Example: 8 |
DocumentId
|
array |
OptionalDocumentIds for Cash on Delivery Example: SA-46789 |
MonetaryAccount
|
object |
OptionalDescription of where the money should be received |
TransactionIdentifier
|
object |
OptionalSenders identifier for the transaction |
Value
|
string |
RequiredThe value to identify where the money should be sent Example: 1234.12.123456 |
accountType
|
string |
RequiredTypeof account to receive payment Possible values:
Example: Bank |
identifierType
|
string |
RequiredType of cash on delivery Possible values:
Example: PQ |
codType
|
string |
RequiredType of cash on delivery Possible values:
Example: CashOnDelivery |
Field | Type | Description |
---|---|---|
CustomsDetails
|
array |
OptionalList of Customs Details for goods being shipped |
CountryOfOrigin
|
string |
OptionalCountry of origin of the package |
CustomsArticleNumber
|
string |
OptionalCustoms Article Number of the package |
GoodsDescription
|
string |
OptionalGoods Description of the package |
NetWeight
|
number |
OptionalNet weight of the package |
Quantity
|
number |
OptionalQuantity of packages |
TariffLineAmount
|
object |
OptionalTariff Line Amount of the package |
Value
|
number |
OptionalValue of the tariff line |
currencyCode
|
string |
OptionalCurrency code of the tariff line |
DangerousGoods
|
array |
OptionalInformation about dangerousgoods being shipped |
GoodsDescription
|
string |
OptionalDescription of goods being shipped Example: Contains socks |
LoadCarrier
|
string |
OptionalTransport equipment (pallet, container etc) Example: EFP |
Package
|
array |
RequiredList of packages being shipped |
email
|
string |
RequiredRecipient’s email address. |
phoneNumber
|
string |
RequiredRecipient’s phone number, including country code. Pattern: \+[0-9 ]+ Example: +4700000000 |
postalCode
|
string |
RequiredA valid Norwegian postal code. |
recipientName
|
string |
RequiredRecipient name. |
rfid
|
boolean |
RequiredWhether to activate tracking with RFID for the package. |
streetAddress
|
string |
RequiredRecipient’s street address. |
weight
|
integer |
RequiredWeight in grams. |
PackageTypeCode
|
string |
RequiredTypes of cargo, packaging of cargo. Either use supported enumeration or UN/ECE Recommendation 21 |
PackingDetails
|
array |
OptionalList of Package Details for goods being shipped |
ArticleDescription
|
string |
OptionalArtical description of Packing Details |
ArticleNumber
|
string |
OptionalArticla details of Packing Details |
ArticlePrice
|
object |
OptionalArtical Price of the Packing Details |
Value
|
number |
OptionalValue of packages |
currencyCode
|
string |
OptionalQuantity of packages |
ItemBackOrder
|
number |
OptionalItem Back Order within Packing Details |
ItemDelivered
|
number |
OptionalItem Delivered within Packing Details |
ItemOrdered
|
number |
OptionalItem Ordered within the Packing Details |
ItemUnity
|
string |
OptionalItem Unity within Packing Details |
PositionNumber
|
integer |
OptionalPosition number within Packing Details |
SealId
|
string |
OptionalItem sealed for customs etc, number of the seal Example: 123456 |
Temperature
|
object |
OptionalTemperature requirements for goods being shipped |
Storage
|
object |
RequiredTemperature requirements for storage of goods |
Value
|
integer |
RequiredSpecific temperature for transportation of the cargo Example: 3 |
maximum
|
string |
OptionalMaximum allowed temperature Example: 4 |
minimum
|
string |
OptionalMinimum allowed temperature Example: -8 |
unitCode
|
string |
RequiredUnit code for temperature measure Possible values:
Example: CEL |
Transport
|
object |
RequiredTemperature requirements during transport |
Value
|
integer |
RequiredSpecific temperature for transportation of the cargo Example: 3 |
maximum
|
string |
OptionalMaximum allowed temperature Example: 4 |
minimum
|
string |
OptionalMinimum allowed temperature Example: -8 |
unitCode
|
string |
RequiredUnit code for temperature measure Possible values:
Example: CEL |
Field | Type | Description |
---|---|---|
AccountHolderName
|
string |
RequiredName of the owner of the account Example: Ola Nordmann |
AccountNumber
|
object |
RequiredAccount number to receive payment |
Value
|
string |
RequiredActual account number Example: 4567.45.12345 |
accountType
|
string |
RequiredType of account to receive payment on delivery Possible values:
|
BankName
|
string |
RequiredBank where account is created Example: DNB |
SwiftCode
|
string |
RequiredSwift code for international transfers Example: DNBANOKK |
Field | Type | Description |
---|---|---|
AdditionalHazard
|
string |
OptionalAdditional codes for hazard Example: 2.3(8) |
Flashpoint
|
object |
RequiredFlashpointinformation for dangerousgoods (when will the item become volatile?) |
Value
|
integer |
OptionalValue when flashpoint occurs/ignites Example: 18 |
unitCode
|
string |
OptionalUnit code for flashpoint Possible values:
Example: CEL |
HazardClass
|
string |
OptionalClassification of hazard Example: 4.1 |
HazardPoints
|
integer |
OptionalPoints for this hazard. Calculated from factor for dangerousgoods multiplied by amount in kg / dm3 for each material in cargo Example: 10 |
Measures
|
array |
OptionalMeasures for Dangerous Goods |
Measure
|
object |
OptionalMeasurements for goods |
Value
|
number |
OptionalMeasure value Example: 1.22 |
unitCode
|
string |
OptionalUnit code for measure Example: DMQ |
subClass
|
string |
Optional Example: NetHazardWeight |
PackingGroup
|
string |
OptionalPacking danger level code, roman numeral between 1 and 3 Example: II |
Restrictions
|
array |
OptionalRestrictions when carrying these hazardous goods |
Value
|
string |
OptionalFreetext specification of restriction for given tunnel. One element for each UN number in the dangerousgoods sequence Example: Ellingsøy- og Valderøytunnelen på riksveg 658 utenfor Ålesund. Her gjelder tunnelkategori C i tidsrommet kl. 0600–2400 hver dag |
restrictionType
|
string |
OptionalType of restriction Possible values:
Example: Tunnel |
TechnicalName
|
string |
OptionalTechnical name of hazard Example: KALSIUMRESINAT, SINTRET |
UNDGInformation
|
object |
RequiredUnited nations dangerous goods information |
FlashpointDescription
|
string |
OptionalFlashpoint for dangerous goods Example: BLACK POWDER, granulated or in powderform |
HazardIdentifier
|
string |
OptionalUnited nations dangerous goods hazard identifier Example: 1.1D |
regulatonCode
|
string |
OptionalRegulation codes for the hazardous goods Example: ADR |
{
"RequestVersion": "1",
"RequestDate": "2018-11-21T10:34:25.4301835+01:00",
"Shipment": {
"updateIndicator": "Original",
"shipmentType": "Instruction",
"ShipmentHeaders": {
"SendersReference": "CUSTOMERS REFERENCE",
"NumberOfPackages": "2",
"AdditionalReference": [
{
"ReferenceValue": "4440/0189981/WEJ",
"referenceType": "TRANSPORT_DOCUMENT_NUMBER"
},
{
"ReferenceValue": "44057673",
"referenceType": "PROJECT_NUMBER"
}
],
"FreeText": [
{
"Text": [
{
"Value": "My instructions for pickup"
}
],
"usageCode": "PICKUP_INSTRUCTIONS"
},
{
"Text": [
{
"sequence": "0",
"Value": "31x20x3 7. etg. Skal hentes på resepsjon "
}
],
"usageCode": "CARRIER_INSTRUCTIONS"
},
{
"Text": [
{
"sequence": "0",
"Value": "Skal leveres til resepsjon"
}
],
"usageCode": "DELIVERY_INSTRUCTIONS"
}
],
"GrossWeight": {
"unitCode": 1,
"Value": 112.0
},
"GrossVolume": {
"unitCode": 1,
"Value": 1.86
},
"LoadingMetres": 0.0,
"PalletFootPrints": 0.0,
"HazardPoints": 0.0,
"shipmentId": "73500012345678911"
},
"DateAndTimes": [
{
"subClass": "PickupEarliest",
"DateTime": "2018-11-21T14:34:25.4301835+01:00"
},
{
"subClass": "DeliveryEarliest",
"DateTime": "2018-11-21T18:34:25.4301835+01:00"
},
{
"subClass": "DeliveryLatest",
"DateTime": "2018-11-21T20:34:25.4301835+01:00"
},
{
"subClass": "DocumentDate",
"DateTime": "2018-11-21T10:34:25.4301835+01:00"
}
],
"Sender": {
"partyId": "00096882527",
"Name": "Sender name",
"Address": {
"AddressLine": [
"MyStreet 123"
],
"PostalCode": "5122",
"City": "My City",
"CountryCode": "NO"
},
"MobilePhone": "12345678",
"Email": "Sender@Sender.com"
},
"Receiver": {
"Name": "Receiver name",
"Address": {
"AddressLine": [
"MyStreet 123"
],
"PostalCode": "5122",
"City": "Other City",
"CountryCode": "NO"
},
"MobilePhone": "87654321",
"Email": "Receiver@Receiver.com"
},
"AdditionalParty": [
{
"subClass": "TransportCompany",
"partyId": "BEX",
"subPartyId": "GLW"
}
],
"ProductAndService": {
"ProductCode": "COURIER_1H",
"AdditionalService": [
{
"AdditionalServiceCode": "EVARSLING"
}
]
},
"DeliveryTerms": {
"ConditionCode": "12",
"Location": {
"City": "Bergen",
"CountryCode": "NO"
},
"termsType": 0
},
"CashOnDelivery": {
"TransactionIdentifier": {
"identifierType": 1,
"accountType": "Unleaded",
"Value": "12444422"
},
"Amount": {
"currencyCode": "NOK"
},
"ControlDigit": 1233.0,
"DocumentId": [
"12223"
],
"MonetaryAccount": {
"AccountNumber": {
"accountType": 0,
"channel": "Magic",
"Value": "12345.01.123654"
},
"SwiftCode": "DNBNOAK-123332",
"BankName": "DNB",
"AccountHolderName": "Name Nameson"
},
"codType": "12",
"codeListIdentifier": "12",
"codeListAgencyIdentifier": "agencyIdent",
"name": "Navn"
},
"GoodsItem": [
{
"PackageTypeCode": "code",
"GoodsDescription": "Socks",
"Temperature": {
"Transport": {
"unitCode": 0,
"minimum": "0",
"maximum": "5",
"Value": 2.0
},
"Storage": {
"unitCode": 0,
"minimum": "0",
"maximum": "5",
"Value": 2.0
}
},
"Package": [
{
"GrossWeight": {
"unitCode": 1,
"Value": 1.0
},
"GrossVolume": {
"unitCode": 0,
"Value": 22.0
},
"Dimensions": {
"Height": {
"unitCode": 2,
"Value": 22.0
},
"Length": {
"unitCode": 2,
"Value": 22.0
},
"Width": {
"unitCode": 2,
"Value": 22.0
}
},
"Insurance": {
"InsuranceValue": {
"currencyCode": "NOK",
"Value": 200000.0
},
"GoodsDescription": "Gullbarre",
"Email": "insurance@vesta.no"
},
"packageId": "373500123456789012"
},
{
"GrossWeight": {
"unitCode": 1,
"Value": 1.0
},
"GrossVolume": {
"unitCode": 0,
"Value": 22.0
},
"Dimensions": {
"Height": {
"unitCode": 2,
"Value": 22.0
},
"Length": {
"unitCode": 2,
"Value": 22.0
},
"Width": {
"unitCode": 2,
"Value": 22.0
}
},
"Insurance": {
"InsuranceValue": {
"currencyCode": "NOK",
"Value": 200000.0
},
"GoodsDescription": "Gullbarre",
"Email": "insurance@vesta.no"
},
"packageId": "37350012345678929"
}
],
"DangerousGoods": {
"UNDGInformation": {
"HazardIdentifier": "1314"
},
"HazardClass": "4.1",
"AdditionalHazard": "2.3(8)",
"PackingGroup": "3",
"Measures": [
{
"Measure": {
"unitCode": "KGM",
"Value": 2.500
},
"subClass": "NetHazardWeight"
}
],
"TechnicalName": "KALSIUMRESINAT, SINTRET",
"Restrictions": [
{
"restrictionType": 0,
"Value": "3(E)"
}
],
"HazardPoints": 10.0,
"regulationCode": "ADR"
}
}
]
}
}
Sample request to book a Bring Express Courier shipment.
{
"RequestVersion": "1",
"RequestDate": "2018-11-21T10:34:25.4301835+01:00",
"Shipment": {
"updateIndicator": "Original",
"shipmentType": "Instruction",
"ShipmentHeaders": {
"SendersReference": "CUSTOMERS REFERENCE",
"NumberOfPackages": "2",
"AdditionalReference": [
{
"ReferenceValue": "4440/0189981/WEJ",
"referenceType": "TRANSPORT_DOCUMENT_NUMBER"
},
{
"ReferenceValue": "44057673",
"referenceType": "PROJECT_NUMBER"
}
],
"FreeText": [
{
"Text": [
{
"Value": "My instructions for pickup"
}
],
"usageCode": "PICKUP_INSTRUCTIONS"
},
{
"Text": [
{
"sequence": "0",
"Value": "31x20x3 7. etg. Skal hentes på resepsjon "
}
],
"usageCode": "CARRIER_INSTRUCTIONS"
},
{
"Text": [
{
"sequence": "0",
"Value": "Skal leveres til resepsjon"
}
],
"usageCode": "DELIVERY_INSTRUCTIONS"
}
],
"GrossWeight": {
"unitCode": 1,
"Value": 112.0
},
"GrossVolume": {
"unitCode": 1,
"Value": 1.86
},
"LoadingMetres": 0.0,
"PalletFootPrints": 0.0,
"HazardPoints": 0.0,
"shipmentId": "73500012345678911"
},
"DateAndTimes": [
{
"subClass": "PickupEarliest",
"DateTime": "2018-11-21T14:34:25.4301835+01:00"
},
{
"subClass": "DeliveryEarliest",
"DateTime": "2018-11-21T18:34:25.4301835+01:00"
},
{
"subClass": "DeliveryLatest",
"DateTime": "2018-11-21T20:34:25.4301835+01:00"
},
{
"subClass": "DocumentDate",
"DateTime": "2018-11-21T10:34:25.4301835+01:00"
}
],
"Sender": {
"partyId": "00096882527",
"Name": "Sender name",
"Address": {
"AddressLine": [
"MyStreet 123"
],
"PostalCode": "5122",
"City": "My City",
"CountryCode": "NO"
},
"MobilePhone": "12345678",
"Email": "Sender@Sender.com"
},
"Receiver": {
"Name": "Receiver name",
"Address": {
"AddressLine": [
"MyStreet 123"
],
"PostalCode": "5122",
"City": "Other City",
"CountryCode": "NO"
},
"MobilePhone": "87654321",
"Email": "Receiver@Receiver.com"
},
"AdditionalParty": [
{
"subClass": "TransportCompany",
"partyId": "BEX",
"subPartyId": "GLW"
}
],
"ProductAndService": {
"ProductCode": "COURIER_1H",
"AdditionalService": [
{
"AdditionalServiceCode": "EVARSLING"
}
]
},
"DeliveryTerms": {
"ConditionCode": "12",
"Location": {
"City": "Bergen",
"CountryCode": "NO"
},
"termsType": 0
},
"CashOnDelivery": {
"TransactionIdentifier": {
"identifierType": 1,
"accountType": "Unleaded",
"Value": "12444422"
},
"Amount": {
"currencyCode": "NOK"
},
"ControlDigit": 1233.0,
"DocumentId": [
"12223"
],
"MonetaryAccount": {
"AccountNumber": {
"accountType": 0,
"channel": "Magic",
"Value": "12345.01.123654"
},
"SwiftCode": "DNBNOAK-123332",
"BankName": "DNB",
"AccountHolderName": "Name Nameson"
},
"codType": "12",
"codeListIdentifier": "12",
"codeListAgencyIdentifier": "agencyIdent",
"name": "Navn"
},
"GoodsItem": [
{
"PackageTypeCode": "code",
"GoodsDescription": "Socks",
"Temperature": {
"Transport": {
"unitCode": 0,
"minimum": "0",
"maximum": "5",
"Value": 2.0
},
"Storage": {
"unitCode": 0,
"minimum": "0",
"maximum": "5",
"Value": 2.0
}
},
"Package": [
{
"GrossWeight": {
"unitCode": 1,
"Value": 1.0
},
"GrossVolume": {
"unitCode": 0,
"Value": 22.0
},
"Dimensions": {
"Height": {
"unitCode": 2,
"Value": 22.0
},
"Length": {
"unitCode": 2,
"Value": 22.0
},
"Width": {
"unitCode": 2,
"Value": 22.0
}
},
"Insurance": {
"InsuranceValue": {
"currencyCode": "NOK",
"Value": 200000.0
},
"GoodsDescription": "Gullbarre",
"Email": "insurance@vesta.no"
},
"packageId": "373500123456789012"
},
{
"GrossWeight": {
"unitCode": 1,
"Value": 1.0
},
"GrossVolume": {
"unitCode": 0,
"Value": 22.0
},
"Dimensions": {
"Height": {
"unitCode": 2,
"Value": 22.0
},
"Length": {
"unitCode": 2,
"Value": 22.0
},
"Width": {
"unitCode": 2,
"Value": 22.0
}
},
"Insurance": {
"InsuranceValue": {
"currencyCode": "NOK",
"Value": 200000.0
},
"GoodsDescription": "Gullbarre",
"Email": "insurance@vesta.no"
},
"packageId": "37350012345678929"
}
],
"DangerousGoods": {
"UNDGInformation": {
"HazardIdentifier": "1314"
},
"HazardClass": "4.1",
"AdditionalHazard": "2.3(8)",
"PackingGroup": "3",
"Measures": [
{
"Measure": {
"unitCode": "KGM",
"Value": 2.500
},
"subClass": "NetHazardWeight"
}
],
"TechnicalName": "KALSIUMRESINAT, SINTRET",
"Restrictions": [
{
"restrictionType": 0,
"Value": "3(E)"
}
],
"HazardPoints": 10.0,
"regulationCode": "ADR"
}
}
]
}
}
Media type: application/xml
Field | Type | Description |
---|---|---|
RequestDate
|
datetime |
RequiredDate and time for when the request was created Example: 2018-11-22T08:58:52 |
RequestVersion
|
number |
RequiredRequest version to use Example: 1 |
Shipment
|
object |
RequiredStructure for the shipment |
Field | Type | Description |
---|---|---|
AdditionalParty
|
array |
RequiredAdditionalparties for the shipment, repeatable. Refer to detailed instructions |
CashOnDelivery
|
object |
OptionalCash on delivery for the shipment |
DateAndTimes
|
array |
RequiredDate and times for the message, repeatable structure. Several dates are required |
DeliveryTerms
|
object |
OptionalTerms of delivery |
GoodsItem
|
array |
RequiredInformation about the goods being shipped |
ProductAndService
|
object |
RequiredProduct and service codes in addition to value added service structures |
Receiver
|
object |
RequiredStructure to hold receiver information |
Sender
|
object |
RequiredStructure to hold sender information |
ShipmentHeaders
|
object |
RequiredStructure that handles information for the whole shipment |
shipmentType
|
string |
RequiredType of shipment Possible values:
Example: Instruction |
updateIndicator
|
string |
RequiredIs this request an original, update or a deletion Possible values:
Example: Original |
Field | Type | Description |
---|---|---|
AdditionalReference
|
array |
OptionalAdditional references for the shipment as indicated by referenceType |
Dimensions
|
object |
OptionalDimensions required for the whole shipment |
ExchangableEquipment
|
object |
OptionalEquipment that can be reused, ie. pallets |
FreeText
|
array |
OptionalFreetext elements |
GrossVolume
|
object |
OptionalGross volume for the whole shipment |
GrossWeight
|
object |
OptionalGross weight for the whole shipment |
HazardPoints
|
integer |
OptionalSum of hazard points for the shipment Example: 22 |
LoadingMetres
|
number |
OptionalHow many metres of loading space required of a truck’s length Example: 12 |
NumberOfPackages
|
string |
RequiredTotal number of packages for the whole shipment across all goodsitems. Example: 3 |
PalletFootPrints
|
integer |
OptionalHow many pallet footprints are needed for the shipment Example: 3 |
ReceiversReference
|
string |
OptionalReceivers reference for the shipment Example: SOA-123222 |
SendersReference
|
string |
RequiredSenders reference for the shipment Example: SOA-123222 |
shipmentId
|
string |
RequiredId for the whole shipment, can be retrieved by the API Example: 70438101412575352 |
Field | Type | Description |
---|---|---|
DateTime
|
datetime |
RequiredDate and Time Example: 2018-11-22T08:58:52 |
subClass
|
string |
RequiredType of datetime Possible values:
Example: DocumentDate |
Field | Type | Description |
---|---|---|
Address
|
object |
OptionalParty address |
AddressLine
|
array |
RequiredAddress lines. The first line will be mapped to primary address line Example: Kong Oscars gate 12 |
CountryCode
|
string |
RequiredCountry code. Use valid country codes Example: NO |
StateOrRegion
|
string |
OptionalState or region, not in use in the nordic countries Example: Washington DC |
ContactName
|
string |
OptionalContact name for the party Example: Atle Thorstensen |
Email
|
string |
OptionalEmail Example: mail@mail.com |
Fax
|
string |
OptionalFax Example: +4712345678 |
MobilePhone
|
string |
OptionalMobile phone Example: +4712345678 |
Name
|
string |
OptionalParty name Example: Bring |
Phone
|
string |
OptionalPhone Example: +4712345678 |
Reference
|
array |
OptionalReference related to the party, can be used for account number of pallet system in Sweden for insatnce. |
ReferenceValue
|
string |
RequiredExtra Reference Example: 4440/0189981/WEJ |
referenceType
|
string |
RequiredReferenceType Possible values:
Example: TRANSPORT_DOCUMENT_NUMBER |
partyId
|
string |
OptionalIdentifier for the party Example: BEX |
subPartyId
|
string |
OptionalFurther identification of the party Example: GLW |
Field | Type | Description |
---|---|---|
Address
|
object |
OptionalParty address |
AddressLine
|
array |
RequiredAddress lines. The first line will be mapped to primary address line Example: Kong Oscars gate 12 |
CountryCode
|
string |
RequiredCountry code. Use valid country codes Example: NO |
StateOrRegion
|
string |
OptionalState or region, not in use in the nordic countries Example: Washington DC |
ContactName
|
string |
OptionalContact name for the party Example: Atle Thorstensen |
Email
|
string |
OptionalEmail Example: mail@mail.com |
Fax
|
string |
OptionalFax Example: +4712345678 |
MobilePhone
|
string |
OptionalMobile phone Example: +4712345678 |
Name
|
string |
OptionalParty name Example: Bring |
Phone
|
string |
OptionalPhone Example: +4712345678 |
Reference
|
array |
OptionalReference related to the party, can be used for account number of pallet system in Sweden for insatnce. |
ReferenceValue
|
string |
RequiredExtra Reference Example: 4440/0189981/WEJ |
referenceType
|
string |
RequiredReferenceType Possible values:
Example: TRANSPORT_DOCUMENT_NUMBER |
partyId
|
string |
OptionalIdentifier for the party Example: BEX |
subPartyId
|
string |
OptionalFurther identification of the party Example: GLW |
Field | Type | Description |
---|---|---|
Address
|
object |
OptionalParty address |
AddressLine
|
array |
RequiredAddress lines. The first line will be mapped to primary address line Example: Kong Oscars gate 12 |
CountryCode
|
string |
RequiredCountry code. Use valid country codes Example: NO |
StateOrRegion
|
string |
OptionalState or region, not in use in the nordic countries Example: Washington DC |
ContactName
|
string |
OptionalParty contact name Example: Ola Nordmann |
Email
|
string |
OptionalEmail Example: mail@mail.com |
Fax
|
string |
OptionalFax Example: +4712345678 |
MobilePhone
|
string |
OptionalMobile phone Example: +4712345678 |
Name
|
string |
OptionalParty name Example: Rogers antistatiske overledninger |
Phone
|
string |
OptionalPhone Example: +4712345678 |
Reference
|
array |
OptionalFuther references related to the party Example: SOA-121232332-AN |
ReferenceValue
|
string |
RequiredExtra Reference Example: 4440/0189981/WEJ |
referenceType
|
string |
RequiredReferenceType Possible values:
Example: TRANSPORT_DOCUMENT_NUMBER |
partyId
|
string |
RequiredIdentifier for the party Example: BEX |
subClass
|
string |
RequiredType of Party Possible values:
Example: DeliveryParty |
subPartyId
|
string |
OptionalFurther identification for the party Example: GLW |
Field | Type | Description |
---|---|---|
AdditionalService
|
array |
OptionalAdditional service codes |
AdditionalServiceCode
|
string |
RequiredThe additional service code for the product Example: EVARSLING |
ServiceRequirements
|
array |
RequiredSome AdditionalServiceCodes / valueadded service might require extra information |
NatureOfCargo
|
string |
OptionalIndicates if the cargo is out of bound of general expected parameters, dangerous goods or out og gauge Example: 11 |
ProductCode
|
string |
RequiredProductcode for shipment, refer to documentation for valid productcodes for this service Example: COURIER_1H |
TariffReference
|
string |
OptionalAdditional information about the price of the cargo in connection with the service Possible values:
Example: GNCG |
Field | Type | Description |
---|---|---|
ConditionCode
|
string |
RequiredThe actual terms for the chosen deliverytermstype Example: EXW |
Location
|
object |
OptionalThe location where the given deliveryterms (condition) applies (to or from given conditioncode.) |
City
|
string |
RequiredCity where the deliveryterms are valid to or from Example: Bergen |
CountryCode
|
string |
RequiredCountry where the deliveryterms ar valid to or from Example: NO |
termsType
|
string |
RequiredTerms valid for this shipment Possible values:
Example: Incoterms |
Field | Type | Description |
---|---|---|
Amount
|
object |
OptionalAmount expected on delivery Example: 123450 |
currencyCode
|
string |
RequiredCurrencycode, valid currency codes allowed Example: NOK |
ControlDigit
|
integer |
OptionalControl digit for incoming amount when there is specified a KID number (norwegian only) Example: 8 |
DocumentId
|
array |
OptionalDocumentIds for Cash on Delivery Example: SA-46789 |
MonetaryAccount
|
object |
OptionalDescription of where the money should be received |
TransactionIdentifier
|
object |
OptionalSenders identifier for the transaction |
Value
|
string |
RequiredThe value to identify where the money should be sent Example: 1234.12.123456 |
accountType
|
string |
RequiredTypeof account to receive payment Possible values:
Example: Bank |
identifierType
|
string |
RequiredType of cash on delivery Possible values:
Example: PQ |
codType
|
string |
RequiredType of cash on delivery Possible values:
Example: CashOnDelivery |
Field | Type | Description |
---|---|---|
CustomsDetails
|
array |
OptionalList of Customs Details for goods being shipped |
CountryOfOrigin
|
string |
OptionalCountry of origin of the package |
CustomsArticleNumber
|
string |
OptionalCustoms Article Number of the package |
GoodsDescription
|
string |
OptionalGoods Description of the package |
NetWeight
|
number |
OptionalNet weight of the package |
Quantity
|
number |
OptionalQuantity of packages |
TariffLineAmount
|
object |
OptionalTariff Line Amount of the package |
Value
|
number |
OptionalValue of the tariff line |
currencyCode
|
string |
OptionalCurrency code of the tariff line |
DangerousGoods
|
array |
OptionalInformation about dangerousgoods being shipped |
GoodsDescription
|
string |
OptionalDescription of goods being shipped Example: Contains socks |
LoadCarrier
|
string |
OptionalTransport equipment (pallet, container etc) Example: EFP |
Package
|
array |
RequiredList of packages being shipped |
email
|
string |
RequiredRecipient’s email address. |
phoneNumber
|
string |
RequiredRecipient’s phone number, including country code. Pattern: \+[0-9 ]+ Example: +4700000000 |
postalCode
|
string |
RequiredA valid Norwegian postal code. |
recipientName
|
string |
RequiredRecipient name. |
rfid
|
boolean |
RequiredWhether to activate tracking with RFID for the package. |
streetAddress
|
string |
RequiredRecipient’s street address. |
weight
|
integer |
RequiredWeight in grams. |
PackageTypeCode
|
string |
RequiredTypes of cargo, packaging of cargo. Either use supported enumeration or UN/ECE Recommendation 21 |
PackingDetails
|
array |
OptionalList of Package Details for goods being shipped |
ArticleDescription
|
string |
OptionalArtical description of Packing Details |
ArticleNumber
|
string |
OptionalArticla details of Packing Details |
ArticlePrice
|
object |
OptionalArtical Price of the Packing Details |
Value
|
number |
OptionalValue of packages |
currencyCode
|
string |
OptionalQuantity of packages |
ItemBackOrder
|
number |
OptionalItem Back Order within Packing Details |
ItemDelivered
|
number |
OptionalItem Delivered within Packing Details |
ItemOrdered
|
number |
OptionalItem Ordered within the Packing Details |
ItemUnity
|
string |
OptionalItem Unity within Packing Details |
PositionNumber
|
integer |
OptionalPosition number within Packing Details |
SealId
|
string |
OptionalItem sealed for customs etc, number of the seal Example: 123456 |
Temperature
|
object |
OptionalTemperature requirements for goods being shipped |
Storage
|
object |
RequiredTemperature requirements for storage of goods |
Value
|
integer |
RequiredSpecific temperature for transportation of the cargo Example: 3 |
maximum
|
string |
OptionalMaximum allowed temperature Example: 4 |
minimum
|
string |
OptionalMinimum allowed temperature Example: -8 |
unitCode
|
string |
RequiredUnit code for temperature measure Possible values:
Example: CEL |
Transport
|
object |
RequiredTemperature requirements during transport |
Value
|
integer |
RequiredSpecific temperature for transportation of the cargo Example: 3 |
maximum
|
string |
OptionalMaximum allowed temperature Example: 4 |
minimum
|
string |
OptionalMinimum allowed temperature Example: -8 |
unitCode
|
string |
RequiredUnit code for temperature measure Possible values:
Example: CEL |
Field | Type | Description |
---|---|---|
AccountHolderName
|
string |
RequiredName of the owner of the account Example: Ola Nordmann |
AccountNumber
|
object |
RequiredAccount number to receive payment |
Value
|
string |
RequiredActual account number Example: 4567.45.12345 |
accountType
|
string |
RequiredType of account to receive payment on delivery Possible values:
|
BankName
|
string |
RequiredBank where account is created Example: DNB |
SwiftCode
|
string |
RequiredSwift code for international transfers Example: DNBANOKK |
Field | Type | Description |
---|---|---|
AdditionalHazard
|
string |
OptionalAdditional codes for hazard Example: 2.3(8) |
Flashpoint
|
object |
RequiredFlashpointinformation for dangerousgoods (when will the item become volatile?) |
Value
|
integer |
OptionalValue when flashpoint occurs/ignites Example: 18 |
unitCode
|
string |
OptionalUnit code for flashpoint Possible values:
Example: CEL |
HazardClass
|
string |
OptionalClassification of hazard Example: 4.1 |
HazardPoints
|
integer |
OptionalPoints for this hazard. Calculated from factor for dangerousgoods multiplied by amount in kg / dm3 for each material in cargo Example: 10 |
Measures
|
array |
OptionalMeasures for Dangerous Goods |
Measure
|
object |
OptionalMeasurements for goods |
Value
|
number |
OptionalMeasure value Example: 1.22 |
unitCode
|
string |
OptionalUnit code for measure Example: DMQ |
subClass
|
string |
Optional Example: NetHazardWeight |
PackingGroup
|
string |
OptionalPacking danger level code, roman numeral between 1 and 3 Example: II |
Restrictions
|
array |
OptionalRestrictions when carrying these hazardous goods |
Value
|
string |
OptionalFreetext specification of restriction for given tunnel. One element for each UN number in the dangerousgoods sequence Example: Ellingsøy- og Valderøytunnelen på riksveg 658 utenfor Ålesund. Her gjelder tunnelkategori C i tidsrommet kl. 0600–2400 hver dag |
restrictionType
|
string |
OptionalType of restriction Possible values:
Example: Tunnel |
TechnicalName
|
string |
OptionalTechnical name of hazard Example: KALSIUMRESINAT, SINTRET |
UNDGInformation
|
object |
RequiredUnited nations dangerous goods information |
FlashpointDescription
|
string |
OptionalFlashpoint for dangerous goods Example: BLACK POWDER, granulated or in powderform |
HazardIdentifier
|
string |
OptionalUnited nations dangerous goods hazard identifier Example: 1.1D |
regulatonCode
|
string |
OptionalRegulation codes for the hazardous goods Example: ADR |
<?xml version="1.0" encoding="utf-8"?>
<CreateShipmentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.bring.com/CreateShipment">
<RequestVersion xmlns="">1</RequestVersion>
<RequestDate xmlns="">2018-11-21T10:35:16.2573224+01:00</RequestDate>
<Shipment updateIndicator="Original" shipmentType="Instruction" xmlns="">
<ShipmentHeaders shipmentId="73500012345678911">
<SendersReference>CUSTOMERS REFERENCE</SendersReference>
<NumberOfPackages>2</NumberOfPackages>
<AdditionalReference referenceType="TRANSPORT_DOCUMENT_NUMBER">
<ReferenceValue>4440/0189981/WEJ</ReferenceValue>
</AdditionalReference>
<AdditionalReference referenceType="PROJECT_NUMBER">
<ReferenceValue>44057673</ReferenceValue>
</AdditionalReference>
<FreeText usageCode="PICKUP_INSTRUCTIONS">
<Text>My instructions for pickup</Text>
</FreeText>
<FreeText usageCode="CARRIER_INSTRUCTIONS">
<Text sequence="0">31x20x3 7. etg. Skal hentes på resepsjon </Text>
</FreeText>
<FreeText usageCode="DELIVERY_INSTRUCTIONS">
<Text sequence="0">Skal leveres til resepsjon</Text>
</FreeText>
<GrossWeight unitCode="KGM">112</GrossWeight>
<GrossVolume unitCode="MTQ">1.86</GrossVolume>
<LoadingMetres>0</LoadingMetres>
<PalletFootPrints>0</PalletFootPrints>
<HazardPoints>0</HazardPoints>
</ShipmentHeaders>
<DateAndTimes subClass="PickupEarliest">
<DateTime>2018-11-21T14:35:16.2573224+01:00</DateTime>
</DateAndTimes>
<DateAndTimes subClass="DeliveryEarliest">
<DateTime>2018-11-21T18:35:16.2573224+01:00</DateTime>
</DateAndTimes>
<DateAndTimes subClass="DeliveryLatest">
<DateTime>2018-11-21T20:35:16.2573224+01:00</DateTime>
</DateAndTimes>
<DateAndTimes subClass="DocumentDate">
<DateTime>2018-11-21T10:35:16.2573224+01:00</DateTime>
</DateAndTimes>
<Sender partyId="00096882527">
<Name>Sender name</Name>
<Address>
<AddressLine>MyStreet 123</AddressLine>
<PostalCode>5122</PostalCode>
<City>My City</City>
<CountryCode>NO</CountryCode>
</Address>
<MobilePhone>12345678</MobilePhone>
<Email>Sender@Sender.com</Email>
</Sender>
<Receiver>
<Name>Receiver name</Name>
<Address>
<AddressLine>MyStreet 123</AddressLine>
<PostalCode>5122</PostalCode>
<City>Other City</City>
<CountryCode>NO</CountryCode>
</Address>
<MobilePhone>87654321</MobilePhone>
<Email>Receiver@Receiver.com</Email>
</Receiver>
<AdditionalParty subClass="TransportCompany" partyId="BEX" subPartyId="GLW" />
<ProductAndService>
<ProductCode>COURIER_1H</ProductCode>
<AdditionalService>
<AdditionalServiceCode>EVARSLING</AdditionalServiceCode>
</AdditionalService>
</ProductAndService>
<DeliveryTerms termsType="Incoterms">
<ConditionCode>12</ConditionCode>
<Location>
<City>Bergen</City>
<CountryCode>NO</CountryCode>
</Location>
</DeliveryTerms>
<CashOnDelivery codType="12" codeListIdentifier="12" codeListAgencyIdentifier="agencyIdent" name="Navn">
<TransactionIdentifier identifierType="SS" accountType="Unleaded">12444422</TransactionIdentifier>
<Amount currencyCode="NOK" />
<ControlDigit>1233</ControlDigit>
<DocumentId>12223</DocumentId>
<MonetaryAccount>
<AccountNumber accountType="Bank" channel="Magic">12345.01.123654</AccountNumber>
<SwiftCode>DNBNOAK-123332</SwiftCode>
<BankName>DNB</BankName>
<AccountHolderName>Name Nameson</AccountHolderName>
</MonetaryAccount>
</CashOnDelivery>
<GoodsItem>
<PackageTypeCode>code</PackageTypeCode>
<GoodsDescription>Socks</GoodsDescription>
<Temperature>
<Transport unitCode="CEL" minimum="0" maximum="5">2</Transport>
<Storage unitCode="CEL" minimum="0" maximum="5">2</Storage>
</Temperature>
<Package packageId="373500123456789012">
<GrossWeight unitCode="KGM">1</GrossWeight>
<GrossVolume unitCode="DMQ">22</GrossVolume>
<Dimensions>
<Height unitCode="MTR">22</Height>
<Length unitCode="MTR">22</Length>
<Width unitCode="MTR">22</Width>
</Dimensions>
<Insurance>
<InsuranceValue currencyCode="NOK">200000</InsuranceValue>
<GoodsDescription>Gullbarre</GoodsDescription>
<Email>insurance@vesta.no</Email>
</Insurance>
</Package>
<Package packageId="37350012345678929">
<GrossWeight unitCode="KGM">1</GrossWeight>
<GrossVolume unitCode="DMQ">22</GrossVolume>
<Dimensions>
<Height unitCode="MTR">22</Height>
<Length unitCode="MTR">22</Length>
<Width unitCode="MTR">22</Width>
</Dimensions>
<Insurance>
<InsuranceValue currencyCode="NOK">200000</InsuranceValue>
<GoodsDescription>Gullbarre</GoodsDescription>
<Email>insurance@vesta.no</Email>
</Insurance>
</Package>
<DangerousGoods regulationCode="ADR">
<UNDGInformation>
<HazardIdentifier>1314</HazardIdentifier>
</UNDGInformation>
<HazardClass>4.1</HazardClass>
<AdditionalHazard>2.3(8)</AdditionalHazard>
<PackingGroup>3</PackingGroup>
<Measures subClass="NetHazardWeight">
<Measure unitCode="KGM">2.500</Measure>
</Measures>
<TechnicalName>KALSIUMRESINAT, SINTRET</TechnicalName>
<Restrictions restrictionType="Tunnel">3(E)</Restrictions>
<HazardPoints>10</HazardPoints>
</DangerousGoods>
</GoodsItem>
</Shipment>
</CreateShipmentRequest>
Sample request to book a Bring Express Courier shipment.
<?xml version="1.0" encoding="utf-8"?>
<CreateShipmentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.bring.com/CreateShipment">
<RequestVersion xmlns="">1</RequestVersion>
<RequestDate xmlns="">2018-11-21T10:35:16.2573224+01:00</RequestDate>
<Shipment updateIndicator="Original" shipmentType="Instruction" xmlns="">
<ShipmentHeaders shipmentId="73500012345678911">
<SendersReference>CUSTOMERS REFERENCE</SendersReference>
<NumberOfPackages>2</NumberOfPackages>
<AdditionalReference referenceType="TRANSPORT_DOCUMENT_NUMBER">
<ReferenceValue>4440/0189981/WEJ</ReferenceValue>
</AdditionalReference>
<AdditionalReference referenceType="PROJECT_NUMBER">
<ReferenceValue>44057673</ReferenceValue>
</AdditionalReference>
<FreeText usageCode="PICKUP_INSTRUCTIONS">
<Text>My instructions for pickup</Text>
</FreeText>
<FreeText usageCode="CARRIER_INSTRUCTIONS">
<Text sequence="0">31x20x3 7. etg. Skal hentes på resepsjon </Text>
</FreeText>
<FreeText usageCode="DELIVERY_INSTRUCTIONS">
<Text sequence="0">Skal leveres til resepsjon</Text>
</FreeText>
<GrossWeight unitCode="KGM">112</GrossWeight>
<GrossVolume unitCode="MTQ">1.86</GrossVolume>
<LoadingMetres>0</LoadingMetres>
<PalletFootPrints>0</PalletFootPrints>
<HazardPoints>0</HazardPoints>
</ShipmentHeaders>
<DateAndTimes subClass="PickupEarliest">
<DateTime>2018-11-21T14:35:16.2573224+01:00</DateTime>
</DateAndTimes>
<DateAndTimes subClass="DeliveryEarliest">
<DateTime>2018-11-21T18:35:16.2573224+01:00</DateTime>
</DateAndTimes>
<DateAndTimes subClass="DeliveryLatest">
<DateTime>2018-11-21T20:35:16.2573224+01:00</DateTime>
</DateAndTimes>
<DateAndTimes subClass="DocumentDate">
<DateTime>2018-11-21T10:35:16.2573224+01:00</DateTime>
</DateAndTimes>
<Sender partyId="00096882527">
<Name>Sender name</Name>
<Address>
<AddressLine>MyStreet 123</AddressLine>
<PostalCode>5122</PostalCode>
<City>My City</City>
<CountryCode>NO</CountryCode>
</Address>
<MobilePhone>12345678</MobilePhone>
<Email>Sender@Sender.com</Email>
</Sender>
<Receiver>
<Name>Receiver name</Name>
<Address>
<AddressLine>MyStreet 123</AddressLine>
<PostalCode>5122</PostalCode>
<City>Other City</City>
<CountryCode>NO</CountryCode>
</Address>
<MobilePhone>87654321</MobilePhone>
<Email>Receiver@Receiver.com</Email>
</Receiver>
<AdditionalParty subClass="TransportCompany" partyId="BEX" subPartyId="GLW" />
<ProductAndService>
<ProductCode>COURIER_1H</ProductCode>
<AdditionalService>
<AdditionalServiceCode>EVARSLING</AdditionalServiceCode>
</AdditionalService>
</ProductAndService>
<DeliveryTerms termsType="Incoterms">
<ConditionCode>12</ConditionCode>
<Location>
<City>Bergen</City>
<CountryCode>NO</CountryCode>
</Location>
</DeliveryTerms>
<CashOnDelivery codType="12" codeListIdentifier="12" codeListAgencyIdentifier="agencyIdent" name="Navn">
<TransactionIdentifier identifierType="SS" accountType="Unleaded">12444422</TransactionIdentifier>
<Amount currencyCode="NOK" />
<ControlDigit>1233</ControlDigit>
<DocumentId>12223</DocumentId>
<MonetaryAccount>
<AccountNumber accountType="Bank" channel="Magic">12345.01.123654</AccountNumber>
<SwiftCode>DNBNOAK-123332</SwiftCode>
<BankName>DNB</BankName>
<AccountHolderName>Name Nameson</AccountHolderName>
</MonetaryAccount>
</CashOnDelivery>
<GoodsItem>
<PackageTypeCode>code</PackageTypeCode>
<GoodsDescription>Socks</GoodsDescription>
<Temperature>
<Transport unitCode="CEL" minimum="0" maximum="5">2</Transport>
<Storage unitCode="CEL" minimum="0" maximum="5">2</Storage>
</Temperature>
<Package packageId="373500123456789012">
<GrossWeight unitCode="KGM">1</GrossWeight>
<GrossVolume unitCode="DMQ">22</GrossVolume>
<Dimensions>
<Height unitCode="MTR">22</Height>
<Length unitCode="MTR">22</Length>
<Width unitCode="MTR">22</Width>
</Dimensions>
<Insurance>
<InsuranceValue currencyCode="NOK">200000</InsuranceValue>
<GoodsDescription>Gullbarre</GoodsDescription>
<Email>insurance@vesta.no</Email>
</Insurance>
</Package>
<Package packageId="37350012345678929">
<GrossWeight unitCode="KGM">1</GrossWeight>
<GrossVolume unitCode="DMQ">22</GrossVolume>
<Dimensions>
<Height unitCode="MTR">22</Height>
<Length unitCode="MTR">22</Length>
<Width unitCode="MTR">22</Width>
</Dimensions>
<Insurance>
<InsuranceValue currencyCode="NOK">200000</InsuranceValue>
<GoodsDescription>Gullbarre</GoodsDescription>
<Email>insurance@vesta.no</Email>
</Insurance>
</Package>
<DangerousGoods regulationCode="ADR">
<UNDGInformation>
<HazardIdentifier>1314</HazardIdentifier>
</UNDGInformation>
<HazardClass>4.1</HazardClass>
<AdditionalHazard>2.3(8)</AdditionalHazard>
<PackingGroup>3</PackingGroup>
<Measures subClass="NetHazardWeight">
<Measure unitCode="KGM">2.500</Measure>
</Measures>
<TechnicalName>KALSIUMRESINAT, SINTRET</TechnicalName>
<Restrictions restrictionType="Tunnel">3(E)</Restrictions>
<HazardPoints>10</HazardPoints>
</DangerousGoods>
</GoodsItem>
</Shipment>
</CreateShipmentRequest>
Responses
HTTP status code 200
Returns a confirmation of successfull delivery and package IDs / shipment IDs if requested.
Media type: application/json
Field | Type | Description |
---|---|---|
EndpointProcessingID
|
string |
Optional |
Errors
|
array |
Optional |
Error
|
string |
OptionalError type Possible values:
|
ErrorText
|
string |
Optional |
Identities
|
array |
Optional |
PackageId
|
array |
Required |
ShipmentId
|
string |
Required |
ProcessingID
|
string |
Optional |
Status
|
string |
Optional Possible values:
|
StatusText
|
string |
Optional |
{
"CreateShipmentResponse": {
"Status": "OK_CONFIRMED",
"StatusText": "Order created",
"Identities": {
"ShipmentId": "70438103433199319",
"PackageId": "370438103696190758"
},
"ProcessingID": "fc3f2481-759e-43a3-a6ae-eb10a2fd183a",
"EndpointProcessingID": "c7167ab6-8e35-46c6-8aff-75087eed9e97"
}
}
Media type: application/xml
Field | Type | Description |
---|---|---|
EndpointProcessingID
|
string |
Optional |
Errors
|
array |
Optional |
Error
|
string |
OptionalError type Possible values:
|
ErrorText
|
string |
Optional |
Identities
|
array |
Optional |
PackageId
|
array |
Required |
ShipmentId
|
string |
Required |
ProcessingID
|
string |
Optional |
Status
|
string |
Optional Possible values:
|
StatusText
|
string |
Optional |
<CreateShipmentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.bring.com/CreateShipment">
<Status>OK_CONFIRMED</Status>
<StatusText>Order created</StatusText>
<Identities ShipmentId="70438103433199319">
<PackageId>370438103696190758</PackageId>
</Identities>
<ProcessingID>fc3f2481-759e-43a3-a6ae-eb10a2fd183a</ProcessingID>
<EndpointProcessingID>c7167ab6-8e35-46c6-8aff-75087eed9e97</EndpointProcessingID>
</CreateShipmentResponse>
HTTP status code 400
Error in validation of request or error in data structure of request.
HTTP status code 417
Missing authentication headers.
HTTP status code 500
Unknown error. Error sending data to destination.
Create shipment booking
Sends a shipment consisting of one consignment, that must include at least one package (transportunit), from one sender to one receiver. The shipment might include additional information in regards to cash on delivery, dangerousgoods etc. If requested through the query parameteres the service will create shipmentid (for the whole shipment) in addition to package ids. The packageids will be returned in the order of the packages (ie. package 1 in the input wil have packageid 1 in returned array).
A valid combination of an additional party, with party type TransportCompany and a valid partyId and optionally subPartyId, and service is required. In addition there might be several valueadded services that can be added. Please refer to this link for both valid product codes/services and VASes.
The structure and most of the content will be validated.
URL
POST https://bapi.bring.com/shipment/sendbooking?shipmentId={createShipmentId}&packageIds={createPackageId}
Request parameters
URI param | Type | Description |
---|---|---|
createPackageId |
boolean |
Required If “true” the API will assign all package IDs for you and return them in the response. |
createShipmentId |
boolean |
Required If “true” the API will assign a shipment ID for you and return it in the response. |
Header name | Type | Description |
---|---|---|
Accept |
string |
Required
Specify response format (application/json, application/xml) Possible values:
|
Content-Type |
string |
Required
Specify request format (application/json, application/xml) Possible values:
|
Request body
Media type: application/json
{
"RequestVersion": "1",
"RequestDate": "2018-11-21T10:36:27.3139022+01:00",
"Shipment": {
"updateIndicator": "Original",
"shipmentType": "Booking",
"ShipmentHeaders": {
"SendersReference": "CUSTOMERS REFERENCE",
"NumberOfPackages": "2",
"AdditionalReference": [
{
"ReferenceValue": "Dummy",
"referenceType": "BOOKING_REFERENCE"
}
],
"FreeText": [
{
"Text": [
{
"Value": "My instructions for pickup"
}
],
"usageCode": "PICKUP_INSTRUCTIONS"
}
],
"GrossWeight": {
"unitCode": 1,
"Value": 2.0
},
"LoadingMetres": 0.0,
"PalletFootPrints": 0.0,
"HazardPoints": 0.0,
"shipmentId": "73500012345678911"
},
"DateAndTimes": [
{
"subClass": "PickupEarliest",
"DateTime": "2018-11-21T14:36:27.3139022+01:00"
},
{
"subClass": "DeliveryEarliest",
"DateTime": "2018-11-21T18:36:27.3139022+01:00"
},
{
"subClass": "DeliveryLatest",
"DateTime": "2018-11-21T20:36:27.3139022+01:00"
},
{
"subClass": "DocumentDate",
"DateTime": "2018-11-21T10:36:27.3139022+01:00"
}
],
"Sender": {
"partyId": "00096882527",
"Name": "Sender name",
"Address": {
"AddressLine": [
"MyStreet 123"
],
"PostalCode": "5122",
"City": "My City",
"CountryCode": "NO"
},
"MobilePhone": "12345678",
"Email": "Sender@Sender.com"
},
"Receiver": {
"Name": "Receiver name",
"Address": {
"AddressLine": [
"MyStreet 123"
],
"PostalCode": "5122",
"City": "Other City",
"CountryCode": "NO"
},
"MobilePhone": "87654321",
"Email": "Receiver@Receiver.com"
},
"AdditionalParty": [
{
"subClass": "TransportCompany",
"partyId": "BEX",
"subPartyId": "ALY"
}
],
"ProductAndService": {
"ProductCode": "COURIER_1H",
"AdditionalService": [
{
"AdditionalServiceCode": "EVARSLING"
}
]
},
"GoodsItem": [
{
"GoodsDescription": "Socks",
"Package": [
{
"GrossWeight": {
"unitCode": 1,
"Value": 1.0
},
"packageId": "373500123456789012"
},
{
"GrossWeight": {
"unitCode": 1,
"Value": 1.0
},
"packageId": "37350012345678929"
}
]
}
]
}
}
Media type: application/xml
<?xml version="1.0" encoding="utf-8"?>
<CreateBookingRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.bring.com/CreateShipment">
<RequestVersion xmlns="">1</RequestVersion>
<RequestDate xmlns="">2019-01-31T07:33:09.9666092+01:00</RequestDate>
<Shipment updateIndicator="Original" shipmentType="Booking" xmlns="">
<ShipmentHeaders shipmentId="73500012345678911">
<SendersReference>CUSTOMERS REFERENCE</SendersReference>
<NumberOfPackages>2</NumberOfPackages>
<AdditionalReference referenceType="BOOKING_REFERENCE">
<ReferenceValue>Dummy</ReferenceValue>
</AdditionalReference>
<FreeText usageCode="PICKUP_INSTRUCTIONS">
<Text>My instructions for pickup</Text>
</FreeText>
<GrossWeight unitCode="KGM">2</GrossWeight>
<LoadingMetres>0</LoadingMetres>
<PalletFootPrints>0</PalletFootPrints>
<HazardPoints>0</HazardPoints>
</ShipmentHeaders>
<DateAndTimes subClass="PickupEarliest">
<DateTime>2019-01-31T11:33:09.9666092+01:00</DateTime>
</DateAndTimes>
<DateAndTimes subClass="DeliveryEarliest">
<DateTime>2019-01-31T15:33:09.9666092+01:00</DateTime>
</DateAndTimes>
<DateAndTimes subClass="DeliveryLatest">
<DateTime>2019-01-31T17:33:09.9666092+01:00</DateTime>
</DateAndTimes>
<DateAndTimes subClass="DocumentDate">
<DateTime>2019-01-31T07:33:09.9666092+01:00</DateTime>
</DateAndTimes>
<Sender partyId="00096882527">
<Name>Sender name</Name>
<Address>
<AddressLine>MyStreet 123</AddressLine>
<PostalCode>5122</PostalCode>
<City>My City</City>
<CountryCode>NO</CountryCode>
</Address>
<MobilePhone>12345678</MobilePhone>
<Email>Sender@Sender.com</Email>
</Sender>
<Receiver>
<Name>Receiver name</Name>
<Address>
<AddressLine>MyStreet 123</AddressLine>
<PostalCode>5122</PostalCode>
<City>Other City</City>
<CountryCode>NO</CountryCode>
</Address>
<MobilePhone>87654321</MobilePhone>
<Email>Receiver@Receiver.com</Email>
</Receiver>
<AdditionalParty subClass="TransportCompany" partyId="BEX" subPartyId="ALY" />
<ProductAndService>
<ProductCode>COURIER_1H</ProductCode>
<AdditionalService>
<AdditionalServiceCode>EVARSLING</AdditionalServiceCode>
</AdditionalService>
</ProductAndService>
<GoodsItem>
<GoodsDescription>Socks</GoodsDescription>
<Package packageId="373500123456789012">
<GrossWeight unitCode="KGM">1</GrossWeight>
</Package>
<Package packageId="37350012345678929">
<GrossWeight unitCode="KGM">1</GrossWeight>
</Package>
</GoodsItem>
</Shipment>
</CreateBookingRequest>
Responses
HTTP status code 200
Returns a confirmation of successfull delivery and package IDs / shipment IDs if requested.
HTTP status code 400
Error in validation of request or error in data structure of request.
HTTP status code 417
Missing authentication headers.
HTTP status code 500
Unknown error. Error sending data to destination.