Skip to main content

Shipment API

The Shipment API is used to book shipments and send transport instructions to Bring. For customers using EDIFACT today, switching to the Shipment API is a good alternative when implementing new automated order solutions. The API supports the majority of services in Bring’s service portfolio and offers options to both create, update and delete bookings and instructions. You may use your own SSCC-compliant labels and your own shipment number series. Using the API requires a good knowledge of Bring’s service portfolio and logistics value chain as the level of content validation is low compared to the Booking 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.

Formats

REST XML/JSON over HTTP. ShipmentAPI endpoints will assume all requests are ISO-8859-1 encoded.

In addition to the documentation on this pages feel free to check out our swagger page for this API.

Checking prices and availability

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.

Shipment API Instructions

A submission to Shipment API must have a ShipmentType of one of the following

HealthCheck

This is simply to check if the service is available.

Unit Codes

A number of different unit codes are used throughout Shipment API. Many of which are listed in the layouts below but the definative list is displayed here for ease of reference.

Cash On Delivery Account Type

  • Bank
  • Bankgiro
  • Plus
  • Post
  • Iban
  • Other

Cash On Delivery Transaction Identifier Type

  • PQ
  • SS

Cash On Delivery Type

  • CashOnDelivery
  • PrePaid
  • CreditCard

Length Unit Code

  • CMT
  • DMT
  • MTR

Party Role

  • DespatchParty
  • DeliveryParty
  • OrderingParty
  • FreightPayer
  • CashOnDeliveryPayee
  • GoodsReturnParty
  • NotifyParty
  • TransportCompany

Temperature Measure Unit Code

  • CEL
  • FAH

Volume Unit Code

  • DMQ
  • MTQ

Weight Unit Code

  • GRM
  • KGM

Dangerous Goods Flashpoint Unit Code

  • CEL
  • FAH

Dangerous Goods Restriction Type

  • Tunnel

Date And Times

  • DocumentDate
  • PickupRequested
  • PickupEarliest
  • PickupLatest
  • DeliveryRequested
  • DeliveryEarliest
  • DeliveryLatest

Delivery Terms Type

  • Incoterms
  • Freightterms
  • Combiterms
  • PrePaid
  • ThirdParty

Exchangeable Equipment Unit Type

  • EFP

Free Text Usage

  • PICKUP_INSTRUCTIONS
  • DELIVERY_INSTRUCTIONS
  • CARRIER_INSTRUCTIONS

Reference Type

  • DESPATCH_ADVICE_NUMBER
  • TRANSPORT_DOCUMENT_NUMBER
  • CUSTOMS_DECLARATION_NUMBER
  • ACCOUNT_NUMBER
  • PROJECT_NUMBER
  • SECONDARY_CUSTOMS_REFERENCE
  • TEMPORARY_IMPORTATION_DOCUMENT_NUMBER
  • SENDERS_REFERENCE
  • AIR_WAYBILL
  • BILL_OF_LADIN
  • BOOKING_REFERENCE
  • ROAD_CONSIGNMENT_NOTE
  • SHIPMENT_REFERENCE
  • TRANSPORT_INSTRUCTION
  • GOODS_NUMBER
  • MESSAGE_SENDERS_IDENTITY
  • AAK
  • AAS
  • ABT
  • ADE
  • AEP
  • AFM
  • AGM
  • AGO
  • AWB
  • BM
  • BN
  • CMR
  • SRN
  • TIN
  • XC
  • MS
  • AFB

Shipment Type

  • Instruction
  • Booking
  • Healthcheck

Tariff Reference

  • COOL_ABERRANT
  • GENERAL_CARGO
  • MINERAL_WATERCHILLED_0_4
  • TIRES
  • COOL_5_8
  • FISH_0_4
  • FROZEN_CARGO
  • FROST_FREE_CARGO
  • EARLY_DELIVERY
  • LATE_DELIVERY
  • SPECIAL_CARGO
  • COOL_0_2

Tariff Reference Values

  • CHLR
  • GNCG
  • BWRG
  • CHLL
  • DEKK
  • COOL
  • FISH
  • FRZE
  • WARM
  • GCED
  • GCLD
  • SPCL
  • CH02

Transport Company

  • BCI
  • BCIOXP
  • BCN
  • BCS
  • BDD
  • BDF
  • BDS
  • BEF
  • BEX
  • BFN
  • BFS
  • BID
  • BPI
  • BPN
  • TIE
  • NPB

Express Sub Transport Company

  • ALY
  • QUI
  • GLW

Cargo Sub Transport Company

  • OXP

Valid Transport Companies

  • BEX
  • BCI
  • BCN

Valid Sub Transport Companies

  • ALY
  • GLW
  • OXP

Update Indicator

  • Original
  • Update
  • Replace
  • Delete

Endpoints

Base URL

https://bapi.bring.com/shipment
Usage Method Endpoint
Request is used to either create, update or delete an instruction for Bring. 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}

Create shipment

Sends a shipment consisting of one consignment, that must include at least one package, from one sender to one receiver.

The ShipmentType must be “Instruction” and must include a Shipment Header.

A Senders reference must be included and must have a value.

The LM Service Codes, in the Shipping Guide, must consist of valid codes (see Unit Codes below).

A valid combination of an additional party, with party type TransportCompany and a valid Transport company code as the partyId value and an optional subPartyId and service, is required. In addition there might be several value added services that can be added. Please refer to valid product codes/services and VASes.

If an included product requires an additional service, that additional service must be included.

Value Added Service Codes may only feature once in any Shipment.

The following Additional Services must be accompanied by the following additions

  • 1000 - must include a Cash on Delivery entry
  • 1036 - must include a SubClass of DeliveryParty entry
  • 1134 - Receiver.ContactName must have a value
  • 1142 - Receiver.ContactName and Receiver.MobilePhone must both have a value
  • 1150 - Receiver.Email must have a value
  • 1245 - must include a DangerousGoods entry

Conversely

When Cash on Delivery is specified, it must be a valid CashOnDelivery and an AdditionalService with value 1000 must be included
When a Goods Item is specified, it must be valid GoodsItem
When a DangerousGoods is specified, AdditionalService must be 1245
The ProductAndService specified must have a valid TariffReference
The Sender specified must be a valid GeneralParty
The Receiver specified, must be a valid GeneralParty
When an AdditionalParty is specified, it must be a valid AdditionalParty and must include a subClass of TransportCompany

If requested through the query parameters, the service will create a shipment ID (for the whole shipment) in addition to package IDs for each package. The package IDs will be returned in the order of the packages (i.e. package 1 in the input will have package ID 1 in returned array).

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.
HTTP header Type Description
Accept string Required Specify response format (application/json, application/xml)
Possible values:
  • application/json
  • application/xml
Content-Type string Required Specify request format (application/json, application/xml)
Possible values:
  • application/json
  • application/xml

Request body

Media type: application/json

CreateShipmentRequest
Field Type Description
RequestDate datetime RequiredDate and time for when the request was created
Example: 2018-11-22T08:58:52Z
RequestVersion number RequiredRequest version to use
Example: 1
Shipment object RequiredStructure for the shipment
Shipment
Field Type Description
AdditionalParty array RequiredAdditionalparties for the shipment, repeatable. Refer to detailed instructions
CashOnDelivery object OptionalCash on delivery for the shipment
CustomsClearance object RequiredCustoms Clearance Information
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 OptionalStructure to hold sender information
ShipmentHeaders object RequiredStructure that handles information for the whole shipment
shipmentType string RequiredType of shipment
Possible values:
  • Instruction
  • Booking
  • Healthcheck

Example: Instruction
updateIndicator string RequiredIs this request an original, update or a deletion
Possible values:
  • Original
  • Update
  • Replace
  • Delete

Example: Original
ShipmentHeaders
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. Must be equal to the number of GoodsItems in the message.
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. ShipmentId must be of length 17 for GS1, 10 for SIS or 11 for UPS.
Example: 70438101412575352
DateAndTimes
Field Type Description
DateTime datetime RequiredDate and Time (for non DocumentDate, date cannot be in the past)
Example: 2018-11-22T08:58:52Z
subClass string RequiredType of datetime
Possible values:
  • DocumentDate
  • PickupRequested
  • PickupEarliest
  • PickupLatest
  • DeliveryRequested
  • DeliveryEarliest
  • DeliveryLatest

Example: DocumentDate
Sender
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]
City string RequiredCity for the posatl code
Example: Morvik
CountryCode string RequiredCountry code. Use valid country codes
Example: NO
PostalCode string RequiredPostal code for address
Example: 5122
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 (compulsory if DangerousGoods are specified)
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 instance.
ReferenceValue string RequiredExtra Reference
Example: 4440/0189981/WEJ
referenceType string RequiredReferenceType
Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER
  • CUSTOMS_DECLARATION_NUMBER (ABT)
  • ACCOUNT_NUMBER (ADE)
  • PROJECT_NUMBER (AEP)
  • SECONDARY_CUSTOMS_REFERENCE (AFM)
  • TEMPORARY_IMPORTATION_DOCUMENT_NUMBER (AGM)
  • SENDERS_REFERENCE (AGO)
  • AIR_WAYBILL (AWB)
  • BILL_OF_LADING (BM)
  • BOOKING_REFERENCE (BN)
  • ROAD_CONSIGNMENT_NOTE (CMR)
  • SHIPMENT_REFERENCE (SRN)
  • TRANSPORT_INSTRUCTION (TIN)
  • GOODS_NUMBER (XC)
  • MESSAGE_SENDERS_IDENTITY (MS)

Example: TRANSPORT_DOCUMENT_NUMBER
partyId string RequiredIdentifier for the party (compulsory if Receiver partyId and additionalParty of ‘FreightPayer’ not specified).
Example: BEX
subPartyId string OptionalFurther identification of the party
Example: GLW
Receiver
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]
City string RequiredCity for the posatl code
Example: Morvik
CountryCode string RequiredCountry code. Use valid country codes
Example: NO
PostalCode string RequiredPostal code for address
Example: 5122
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 instance.
ReferenceValue string RequiredExtra Reference
Example: 4440/0189981/WEJ
referenceType string RequiredReferenceType
Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER
  • CUSTOMS_DECLARATION_NUMBER (ABT)
  • ACCOUNT_NUMBER (ADE)
  • PROJECT_NUMBER (AEP)
  • SECONDARY_CUSTOMS_REFERENCE (AFM)
  • TEMPORARY_IMPORTATION_DOCUMENT_NUMBER (AGM)
  • SENDERS_REFERENCE (AGO)
  • AIR_WAYBILL (AWB)
  • BILL_OF_LADING (BM)
  • BOOKING_REFERENCE (BN)
  • ROAD_CONSIGNMENT_NOTE (CMR)
  • SHIPMENT_REFERENCE (SRN)
  • TRANSPORT_INSTRUCTION (TIN)
  • GOODS_NUMBER (XC)
  • MESSAGE_SENDERS_IDENTITY (MS)

Example: TRANSPORT_DOCUMENT_NUMBER
partyId string OptionalIdentifier for the party (compulsory if Sender partyId and additionalParty of ‘FreightPayer’ not specified).
Example: BEX
subPartyId string OptionalFurther identification of the party
Example: GLW
AdditionalParty
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]
City string RequiredCity for the posatl code
Example: Morvik
CountryCode string RequiredCountry code. Use valid country codes
Example: NO
PostalCode string RequiredPostal code for address
Example: 5122
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 OptionalFurther references related to the party
ReferenceValue string RequiredExtra Reference
Example: 4440/0189981/WEJ
referenceType string RequiredReferenceType
Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER
  • CUSTOMS_DECLARATION_NUMBER (ABT)
  • ACCOUNT_NUMBER (ADE)
  • PROJECT_NUMBER (AEP)
  • SECONDARY_CUSTOMS_REFERENCE (AFM)
  • TEMPORARY_IMPORTATION_DOCUMENT_NUMBER (AGM)
  • SENDERS_REFERENCE (AGO)
  • AIR_WAYBILL (AWB)
  • BILL_OF_LADING (BM)
  • BOOKING_REFERENCE (BN)
  • ROAD_CONSIGNMENT_NOTE (CMR)
  • SHIPMENT_REFERENCE (SRN)
  • TRANSPORT_INSTRUCTION (TIN)
  • GOODS_NUMBER (XC)
  • MESSAGE_SENDERS_IDENTITY (MS)

Example: TRANSPORT_DOCUMENT_NUMBER
partyId string RequiredIdentifier for the party
Example: BEX
subClass string RequiredType of Party (at least one subClass must be ‘TansportCompany’)
Possible values:
  • DespatchParty
  • DeliveryParty
  • OrderingParty
  • FreightPayer
  • CashOnDeliveryPayee
  • GoodsReturnParty
  • NotifyParty
  • TransportCompany

Example: DeliveryParty
subPartyId string OptionalFurther identification for the party
Example: GLW
ProductAndService
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 of 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:
  • COOL_ABERRANT
  • GENERAL_CARGO
  • MINERAL_WATER
  • CHILLED_0_4
  • TIRES
  • COOL_5_8
  • FISH_0_4
  • FROZEN_CARGO
  • FROST_FREE_CARGO
  • EARLY_DELIVERY
  • LATE_DELIVERY
  • SPECIAL_CARGO
  • COOL_0_2

Example: GENERAL_CARGO
CustomsClearance
Field Type Description
Location object OptionalLocation definition
LocationName string OptionalName of Location
Example: OSL Gardemoen
idType string Optional(attribute) Type of id
Example: 157
locationId string Optional(attribute) Id of location
Example: NO123456
subClass string Optional(attribute) Location sub class
Example: BorderPAssing
TransactionType string OptionalType of transaction
Utility object OptionalUtility Definition
UtilityValue array Optional
UtilityText string Optional
utilityValueCode string Optional(attribute)
utilityValueType string Optional(attribute)
usageCode string Optional(attribute) Usage of Utility
Example: BorderPassing
function string Optional(attribute) Function descriptor
Example: Final
lineMerge string Optional(attribute) Line merge value
Example: Yes
status string Optional(attribute) status of customs clearance
Example: Import
DeliveryTerms
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:
  • Incoterms
  • Freightterms
  • Combiterms
  • PrePaid
  • ThirdParty

Example: Incoterms
CashOnDelivery
Field Type Description
Amount object OptionalAmount expected on delivery
Value string OptionalThe Amount
Example: 123.456
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:
  • Bank
  • Bankgiro
  • Plus
  • Post
  • Iban
  • Other

Example: Bank
identifierType string RequiredType of cash on delivery
Possible values:
  • PQ
  • SS

Example: PQ
codType string RequiredType of cash on delivery
Possible values:
  • CashOnDelivery
  • PrePaid
  • CreditCard

Example: CashOnDelivery
GoodsItem
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
GrossWeight object OptionalGross weight of the package
Value number RequiredWeight Value
Example: 2.33
unitCode string RequiredUnitcode for weight
Possible values:
  • GRM
  • KGM

Example: KGM
NetWeight object OptionalNet weight of the package
Value number RequiredWeight Value
Example: 2.33
unitCode string RequiredUnitcode for weight
Possible values:
  • GRM
  • KGM

Example: KGM
QuantityOtherUnit string 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
TradePreference object OptionalTrade preference data for the package
Value string RequiredTrade Preference value
Example: 3
tradeIndicator string Optional(attribute) Trade indicator
Example: Preference
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
Dimensions object OptionalDimension of the package.
Height object RequiredHeight of package
Value number OptionalThe length
Example: 1.22
unitCode string OptionalUnit for the length
Possible values:
  • CMT
  • DMT
  • MTR

Example: CMT
Length object RequiredLength of package
Value number OptionalThe length
Example: 1.22
unitCode string OptionalUnit for the length
Possible values:
  • CMT
  • DMT
  • MTR

Example: CMT
Width object RequiredWidth of package
Value number OptionalThe length
Example: 1.22
unitCode string OptionalUnit for the length
Possible values:
  • CMT
  • DMT
  • MTR

Example: CMT
GrossVolume object OptionalGross volume of the package.
Value number RequiredValue of the volume measurement
Example: 18.22
unitCode string RequiredUnitcode for volume measurement
Possible values:
  • DMQ
  • MTQ

Example: DMQ
GrossWeight object RequiredGross weight of the package.
Value number RequiredWeight Value
Example: 2.33
unitCode string RequiredUnitcode for weight
Possible values:
  • GRM
  • KGM

Example: KGM
Insurance object OptionalA valid Norwegian postal code.
Email string RequiredEmail related to the insurance information
GoodsDescription string RequiredDescription of the insured package.
Example: Gold
InsuranceValue object RequiredThe Amount the package is insured for.
Value string RequiredAmount the package is insureed for
Example: 10000
currencycode string RequiredCurrencycode for the insured amount
Example: NOK
packageId string RequiredPackageId, can be inserted by the API.
Example: 370438101412578910
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:
  • CEL
  • FAH

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:
  • CEL
  • FAH

Example: CEL
MonetaryAccount
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:
  • Bank
  • Bankgiro
  • Plus
  • Post
  • Iban
  • Other
BankName string RequiredBank where account is created
Example: DNB
SwiftCode string RequiredSwift code for international transfers
Example: DNBANOKK
DangerousGoods
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 RequiredValue when flashpoint occurs/ignites
Example: 18
unitCode string RequiredUnit code for flashpoint
Possible values:
  • CEL
  • FAH

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 RequiredMeasure value
Example: 1.22
unitCode string RequiredUnit 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:
  • Tunnel

Example: Tunnel
TechnicalName string OptionalTechnical name of hazard
Example: KALSIUMRESINAT, SINTRET
UNDGInformation object OptionalUnited 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": "2022-04-20T10:55:07",
  "Shipment": {
    "updateIndicator": "Original",
    "shipmentType": "Instruction",
    "ShipmentHeaders": {
      "SendersReference": "1878959",
      "shipmentId": "70722150702977990",
      "NumberOfPackages": "1",
      "HazardPoints": "0",
      "GrossWeight": {
        "unitCode": "KGM",
        "Value": 1
      },
      "LoadingMetres": "0",
      "PalletFootPrints": "0"
    },
    "DateAndTimes":
    [{
      "subClass": "DocumentDate",
      "DateTime": "2022-04-20T10:55:07"
    }, {
      "subClass": "DeliveryEarliest",
      "DateTime": "2022-04-20T16:00:00"
    }, {
      "subClass": "DeliveryLatest",
      "DateTime": "2022-04-20T21:00:00"
    }, {
      "subClass": "PickupEarliest",
      "DateTime": "2022-04-20T14:00:00"
    }, {
      "subClass": "PickupLatest",
      "DateTime": "2022-04-20T18:00:00"
    }
    ],
    "Sender": {
      "partyId": "28371",
      "Name": "Mester Grønn Oasen Senter Bergen",
      "Address": {
        "AddressLine":
        [
          "Folke Bernadottes vei 52"
        ],
        "PostalCode": "5147",
        "City": "FYLLINGSDALEN",
        "CountryCode": "NO"
      },
      "Phone": "+4732229724"
    },
    "Receiver": {
      "Name": "Trine Elisabeth Rud Riera",
      "Address": {
        "AddressLine":
        [
          "Ture Nermans vei 107"
        ],
        "PostalCode": "5143",
        "City": "FYLLINGSDALEN",
        "CountryCode": "NO"
      },
      "MobilePhone": "98071041"
    },
    "AdditionalParty":
    [{
      "subClass": "GoodsReturnParty",
      "Name":"Ola Nordmann",
      "Address": {
        "PostalCode":"1065",
        "City":"OSLO",
        "CountryCode":"NO",
        "AddressLine":
        [{
          "Storgatan 1"
        }]
      },
      "MobilePhone":"4712345678",
      "Email":"ola.nordmann@someemail.com",
      "ContactName":"Ola Nordmann"
    }
    ],
    "AdditionalParty":
    [{
      "subClass": "TransportCompany",
      "partyId":"BEX",
      "subPartyId":"GLW"
    }
    ],
    "ProductAndService": {
      "ProductCode": "3270"
    },
    "GoodsItem":
    [{
      "PackageTypeCode":"PK",
      "GoodsDescription":"Kittens in a sack",
      "Package":
      [{
        "GrossWeight": {
          "unitCode": "KGM",
          "Value": 1
        },
        "packageId": "370722150758796447"
      }
      ]
    }
    ]
  }
}

Sample request to book a Bring Express Courier shipment.

{
  "RequestVersion": "1",
  "RequestDate": "2022-04-20T10:55:07",
  "Shipment": {
    "updateIndicator": "Original",
    "shipmentType": "Instruction",
    "ShipmentHeaders": {
      "SendersReference": "1878959",
      "shipmentId": "70722150702977990",
      "NumberOfPackages": "1",
      "HazardPoints": "0",
      "GrossWeight": {
        "unitCode": "KGM",
        "Value": 1
      },
      "LoadingMetres": "0",
      "PalletFootPrints": "0"
    },
    "DateAndTimes":
    [{
      "subClass": "DocumentDate",
      "DateTime": "2022-04-20T10:55:07"
    }, {
      "subClass": "DeliveryEarliest",
      "DateTime": "2022-04-20T16:00:00"
    }, {
      "subClass": "DeliveryLatest",
      "DateTime": "2022-04-20T21:00:00"
    }, {
      "subClass": "PickupEarliest",
      "DateTime": "2022-04-20T14:00:00"
    }, {
      "subClass": "PickupLatest",
      "DateTime": "2022-04-20T18:00:00"
    }
    ],
    "Sender": {
      "partyId": "28371",
      "Name": "Mester Grønn Oasen Senter Bergen",
      "Address": {
        "AddressLine":
        [
          "Folke Bernadottes vei 52"
        ],
        "PostalCode": "5147",
        "City": "FYLLINGSDALEN",
        "CountryCode": "NO"
      },
      "Phone": "+4732229724"
    },
    "Receiver": {
      "Name": "Trine Elisabeth Rud Riera",
      "Address": {
        "AddressLine":
        [
          "Ture Nermans vei 107"
        ],
        "PostalCode": "5143",
        "City": "FYLLINGSDALEN",
        "CountryCode": "NO"
      },
      "MobilePhone": "98071041"
    },
    "AdditionalParty":
    [{
      "subClass": "GoodsReturnParty",
      "Name":"Ola Nordmann",
      "Address": {
        "PostalCode":"1065",
        "City":"OSLO",
        "CountryCode":"NO",
        "AddressLine":
        [{
          "Storgatan 1"
        }]
      },
      "MobilePhone":"4712345678",
      "Email":"ola.nordmann@someemail.com",
      "ContactName":"Ola Nordmann"
    }
    ],
    "AdditionalParty":
    [{
      "subClass": "TransportCompany",
      "partyId":"BEX",
      "subPartyId":"GLW"
    }
    ],
    "ProductAndService": {
      "ProductCode": "3270"
    },
    "GoodsItem":
    [{
      "PackageTypeCode":"PK",
      "GoodsDescription":"Kittens in a sack",
      "Package":
      [{
        "GrossWeight": {
          "unitCode": "KGM",
          "Value": 1
        },
        "packageId": "370722150758796447"
      }
      ]
    }
    ]
  }
}

Media type: application/xml

CreateShipmentRequest
Field Type Description
RequestDate datetime RequiredDate and time for when the request was created
Example: 2018-11-22T08:58:52Z
RequestVersion number RequiredRequest version to use
Example: 1
Shipment object RequiredStructure for the shipment
Shipment
Field Type Description
AdditionalParty array RequiredAdditionalparties for the shipment, repeatable. Refer to detailed instructions
CashOnDelivery object OptionalCash on delivery for the shipment
CustomsClearance object RequiredCustoms Clearance Information
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 OptionalStructure to hold sender information
ShipmentHeaders object RequiredStructure that handles information for the whole shipment
shipmentType string RequiredType of shipment
Possible values:
  • Instruction
  • Booking
  • Healthcheck

Example: Instruction
updateIndicator string RequiredIs this request an original, update or a deletion
Possible values:
  • Original
  • Update
  • Replace
  • Delete

Example: Original
ShipmentHeaders
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. Must be equal to the number of GoodsItems in the message.
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. ShipmentId must be of length 17 for GS1, 10 for SIS or 11 for UPS.
Example: 70438101412575352
DateAndTimes
Field Type Description
DateTime datetime RequiredDate and Time (for non DocumentDate, date cannot be in the past)
Example: 2018-11-22T08:58:52Z
subClass string RequiredType of datetime
Possible values:
  • DocumentDate
  • PickupRequested
  • PickupEarliest
  • PickupLatest
  • DeliveryRequested
  • DeliveryEarliest
  • DeliveryLatest

Example: DocumentDate
Sender
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]
City string RequiredCity for the posatl code
Example: Morvik
CountryCode string RequiredCountry code. Use valid country codes
Example: NO
PostalCode string RequiredPostal code for address
Example: 5122
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 (compulsory if DangerousGoods are specified)
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 instance.
ReferenceValue string RequiredExtra Reference
Example: 4440/0189981/WEJ
referenceType string RequiredReferenceType
Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER
  • CUSTOMS_DECLARATION_NUMBER (ABT)
  • ACCOUNT_NUMBER (ADE)
  • PROJECT_NUMBER (AEP)
  • SECONDARY_CUSTOMS_REFERENCE (AFM)
  • TEMPORARY_IMPORTATION_DOCUMENT_NUMBER (AGM)
  • SENDERS_REFERENCE (AGO)
  • AIR_WAYBILL (AWB)
  • BILL_OF_LADING (BM)
  • BOOKING_REFERENCE (BN)
  • ROAD_CONSIGNMENT_NOTE (CMR)
  • SHIPMENT_REFERENCE (SRN)
  • TRANSPORT_INSTRUCTION (TIN)
  • GOODS_NUMBER (XC)
  • MESSAGE_SENDERS_IDENTITY (MS)

Example: TRANSPORT_DOCUMENT_NUMBER
partyId string RequiredIdentifier for the party (compulsory if Receiver partyId and additionalParty of ‘FreightPayer’ not specified).
Example: BEX
subPartyId string OptionalFurther identification of the party
Example: GLW
Receiver
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]
City string RequiredCity for the posatl code
Example: Morvik
CountryCode string RequiredCountry code. Use valid country codes
Example: NO
PostalCode string RequiredPostal code for address
Example: 5122
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 instance.
ReferenceValue string RequiredExtra Reference
Example: 4440/0189981/WEJ
referenceType string RequiredReferenceType
Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER
  • CUSTOMS_DECLARATION_NUMBER (ABT)
  • ACCOUNT_NUMBER (ADE)
  • PROJECT_NUMBER (AEP)
  • SECONDARY_CUSTOMS_REFERENCE (AFM)
  • TEMPORARY_IMPORTATION_DOCUMENT_NUMBER (AGM)
  • SENDERS_REFERENCE (AGO)
  • AIR_WAYBILL (AWB)
  • BILL_OF_LADING (BM)
  • BOOKING_REFERENCE (BN)
  • ROAD_CONSIGNMENT_NOTE (CMR)
  • SHIPMENT_REFERENCE (SRN)
  • TRANSPORT_INSTRUCTION (TIN)
  • GOODS_NUMBER (XC)
  • MESSAGE_SENDERS_IDENTITY (MS)

Example: TRANSPORT_DOCUMENT_NUMBER
partyId string OptionalIdentifier for the party (compulsory if Sender partyId and additionalParty of ‘FreightPayer’ not specified).
Example: BEX
subPartyId string OptionalFurther identification of the party
Example: GLW
AdditionalParty
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]
City string RequiredCity for the posatl code
Example: Morvik
CountryCode string RequiredCountry code. Use valid country codes
Example: NO
PostalCode string RequiredPostal code for address
Example: 5122
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 OptionalFurther references related to the party
ReferenceValue string RequiredExtra Reference
Example: 4440/0189981/WEJ
referenceType string RequiredReferenceType
Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER
  • CUSTOMS_DECLARATION_NUMBER (ABT)
  • ACCOUNT_NUMBER (ADE)
  • PROJECT_NUMBER (AEP)
  • SECONDARY_CUSTOMS_REFERENCE (AFM)
  • TEMPORARY_IMPORTATION_DOCUMENT_NUMBER (AGM)
  • SENDERS_REFERENCE (AGO)
  • AIR_WAYBILL (AWB)
  • BILL_OF_LADING (BM)
  • BOOKING_REFERENCE (BN)
  • ROAD_CONSIGNMENT_NOTE (CMR)
  • SHIPMENT_REFERENCE (SRN)
  • TRANSPORT_INSTRUCTION (TIN)
  • GOODS_NUMBER (XC)
  • MESSAGE_SENDERS_IDENTITY (MS)

Example: TRANSPORT_DOCUMENT_NUMBER
partyId string RequiredIdentifier for the party
Example: BEX
subClass string RequiredType of Party (at least one subClass must be ‘TansportCompany’)
Possible values:
  • DespatchParty
  • DeliveryParty
  • OrderingParty
  • FreightPayer
  • CashOnDeliveryPayee
  • GoodsReturnParty
  • NotifyParty
  • TransportCompany

Example: DeliveryParty
subPartyId string OptionalFurther identification for the party
Example: GLW
ProductAndService
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 of 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:
  • COOL_ABERRANT
  • GENERAL_CARGO
  • MINERAL_WATER
  • CHILLED_0_4
  • TIRES
  • COOL_5_8
  • FISH_0_4
  • FROZEN_CARGO
  • FROST_FREE_CARGO
  • EARLY_DELIVERY
  • LATE_DELIVERY
  • SPECIAL_CARGO
  • COOL_0_2

Example: GENERAL_CARGO
CustomsClearance
Field Type Description
Location object OptionalLocation definition
LocationName string OptionalName of Location
Example: OSL Gardemoen
idType string Optional(attribute) Type of id
Example: 157
locationId string Optional(attribute) Id of location
Example: NO123456
subClass string Optional(attribute) Location sub class
Example: BorderPAssing
TransactionType string OptionalType of transaction
Utility object OptionalUtility Definition
UtilityValue array Optional
UtilityText string Optional
utilityValueCode string Optional(attribute)
utilityValueType string Optional(attribute)
usageCode string Optional(attribute) Usage of Utility
Example: BorderPassing
function string Optional(attribute) Function descriptor
Example: Final
lineMerge string Optional(attribute) Line merge value
Example: Yes
status string Optional(attribute) status of customs clearance
Example: Import
DeliveryTerms
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:
  • Incoterms
  • Freightterms
  • Combiterms
  • PrePaid
  • ThirdParty

Example: Incoterms
CashOnDelivery
Field Type Description
Amount object OptionalAmount expected on delivery
Value string OptionalThe Amount
Example: 123.456
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:
  • Bank
  • Bankgiro
  • Plus
  • Post
  • Iban
  • Other

Example: Bank
identifierType string RequiredType of cash on delivery
Possible values:
  • PQ
  • SS

Example: PQ
codType string RequiredType of cash on delivery
Possible values:
  • CashOnDelivery
  • PrePaid
  • CreditCard

Example: CashOnDelivery
GoodsItem
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
GrossWeight object OptionalGross weight of the package
Value number RequiredWeight Value
Example: 2.33
unitCode string RequiredUnitcode for weight
Possible values:
  • GRM
  • KGM

Example: KGM
NetWeight object OptionalNet weight of the package
Value number RequiredWeight Value
Example: 2.33
unitCode string RequiredUnitcode for weight
Possible values:
  • GRM
  • KGM

Example: KGM
QuantityOtherUnit string 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
TradePreference object OptionalTrade preference data for the package
Value string RequiredTrade Preference value
Example: 3
tradeIndicator string Optional(attribute) Trade indicator
Example: Preference
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
Dimensions object OptionalDimension of the package.
Height object RequiredHeight of package
Value number OptionalThe length
Example: 1.22
unitCode string OptionalUnit for the length
Possible values:
  • CMT
  • DMT
  • MTR

Example: CMT
Length object RequiredLength of package
Value number OptionalThe length
Example: 1.22
unitCode string OptionalUnit for the length
Possible values:
  • CMT
  • DMT
  • MTR

Example: CMT
Width object RequiredWidth of package
Value number OptionalThe length
Example: 1.22
unitCode string OptionalUnit for the length
Possible values:
  • CMT
  • DMT
  • MTR

Example: CMT
GrossVolume object OptionalGross volume of the package.
Value number RequiredValue of the volume measurement
Example: 18.22
unitCode string RequiredUnitcode for volume measurement
Possible values:
  • DMQ
  • MTQ

Example: DMQ
GrossWeight object RequiredGross weight of the package.
Value number RequiredWeight Value
Example: 2.33
unitCode string RequiredUnitcode for weight
Possible values:
  • GRM
  • KGM

Example: KGM
Insurance object OptionalA valid Norwegian postal code.
Email string RequiredEmail related to the insurance information
GoodsDescription string RequiredDescription of the insured package.
Example: Gold
InsuranceValue object RequiredThe Amount the package is insured for.
Value string RequiredAmount the package is insureed for
Example: 10000
currencycode string RequiredCurrencycode for the insured amount
Example: NOK
packageId string RequiredPackageId, can be inserted by the API.
Example: 370438101412578910
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:
  • CEL
  • FAH

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:
  • CEL
  • FAH

Example: CEL
MonetaryAccount
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:
  • Bank
  • Bankgiro
  • Plus
  • Post
  • Iban
  • Other
BankName string RequiredBank where account is created
Example: DNB
SwiftCode string RequiredSwift code for international transfers
Example: DNBANOKK
DangerousGoods
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 RequiredValue when flashpoint occurs/ignites
Example: 18
unitCode string RequiredUnit code for flashpoint
Possible values:
  • CEL
  • FAH

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 RequiredMeasure value
Example: 1.22
unitCode string RequiredUnit 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:
  • Tunnel

Example: Tunnel
TechnicalName string OptionalTechnical name of hazard
Example: KALSIUMRESINAT, SINTRET
UNDGInformation object OptionalUnited 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
<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="">2021-04-20T10:55:07</RequestDate>
  <Shipment updateIndicator="Original" shipmentType="Instruction" xmlns="">
    <ShipmentHeaders shipmentId="70722150702977990">
      <SendersReference>1878959</SendersReference>
      <NumberOfPackages>1</NumberOfPackages>
      <GrossWeight unitCode="KGM">1</GrossWeight>
      <LoadingMetres>0</LoadingMetres>
      <PalletFootPrints>0</PalletFootPrints>
      <HazardPoints>0</HazardPoints>
    </ShipmentHeaders>
    <DateAndTimes subClass="DocumentDate">
      <DateTime>2022-04-20T10:55:07</DateTime>
    </DateAndTimes>
    <DateAndTimes subClass="DeliveryEarliest">
      <DateTime>2022-04-20T16:00:00</DateTime>
    </DateAndTimes>
    <DateAndTimes subClass="DeliveryLatest">
      <DateTime>2022-04-20T21:00:00</DateTime>
    </DateAndTimes>
    <DateAndTimes subClass="PickupEarliest">
      <DateTime>2022-04-20T14:00:00</DateTime>
    </DateAndTimes>
    <DateAndTimes subClass="PickupLatest">
      <DateTime>2022-04-20T18:00:00</DateTime>
    </DateAndTimes>
    <Sender partyId="28371">
      <Name>Mester Grønn Oasen Senter Bergen</Name>
      <Address>
        <AddressLine>Folke Bernadottes vei 52</AddressLine>
        <PostalCode>5147</PostalCode>
        <City>FYLLINGSDALEN</City>
        <CountryCode>NO</CountryCode>
      </Address>
      <Phone>+4732229724</Phone>
    </Sender>
    <Receiver>
      <Name>Trine Elisabeth Rud Riera</Name>
      <Address>
        <AddressLine>Ture Nermans vei 107</AddressLine>
        <PostalCode>5143</PostalCode>
        <City>FYLLINGSDALEN</City>
        <CountryCode>NO</CountryCode>
      </Address>
      <MobilePhone>98071041</MobilePhone>
    </Receiver>
    <AdditionalParty subClass="GoodsReturnParty">
      <Name>Ola Nordmann</Name>
      <Address>
        <PostalCode>1065</PostalCode>
        <City>OSLO</City>
        <CountryCode>NO</CountryCode>
        <AddressLine>Storgatan 1</AddressLine>
      </Address>
      <MobilePhone>4712345678</MobilePhone>
      <Email>ola.nordmann@someemail.com</Email>
      <ContactName>Ola Nordmann</ContactName>
    </AdditionalParty>
    <AdditionalParty subClass="TransportCompany" partyId="BEX" subPartyId="GLW" />
    <ProductAndService>
      <ProductCode>3270</ProductCode>
    </ProductAndService>
    <GoodsItem>
      <PackageTypeCode>PK</PackageTypeCode>
      <GoodsDescription>Kittens in a sack</GoodsDescription>
      <Package packageId="370722150758796447">
        <GrossWeight unitCode="KGM">1</GrossWeight>
      </Package>
    </GoodsItem>
  </Shipment>
</CreateShipmentRequest>

Sample request to book a Bring Express Courier shipment.

<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="">2021-04-20T10:55:07</RequestDate>
  <Shipment updateIndicator="Original" shipmentType="Instruction" xmlns="">
    <ShipmentHeaders shipmentId="70722150702977990">
      <SendersReference>1878959</SendersReference>
      <NumberOfPackages>1</NumberOfPackages>
      <GrossWeight unitCode="KGM">1</GrossWeight>
      <LoadingMetres>0</LoadingMetres>
      <PalletFootPrints>0</PalletFootPrints>
      <HazardPoints>0</HazardPoints>
    </ShipmentHeaders>
    <DateAndTimes subClass="DocumentDate">
      <DateTime>2022-04-20T10:55:07</DateTime>
    </DateAndTimes>
    <DateAndTimes subClass="DeliveryEarliest">
      <DateTime>2022-04-20T16:00:00</DateTime>
    </DateAndTimes>
    <DateAndTimes subClass="DeliveryLatest">
      <DateTime>2022-04-20T21:00:00</DateTime>
    </DateAndTimes>
    <DateAndTimes subClass="PickupEarliest">
      <DateTime>2022-04-20T14:00:00</DateTime>
    </DateAndTimes>
    <DateAndTimes subClass="PickupLatest">
      <DateTime>2022-04-20T18:00:00</DateTime>
    </DateAndTimes>
    <Sender partyId="28371">
      <Name>Mester Grønn Oasen Senter Bergen</Name>
      <Address>
        <AddressLine>Folke Bernadottes vei 52</AddressLine>
        <PostalCode>5147</PostalCode>
        <City>FYLLINGSDALEN</City>
        <CountryCode>NO</CountryCode>
      </Address>
      <Phone>+4732229724</Phone>
    </Sender>
    <Receiver>
      <Name>Trine Elisabeth Rud Riera</Name>
      <Address>
        <AddressLine>Ture Nermans vei 107</AddressLine>
        <PostalCode>5143</PostalCode>
        <City>FYLLINGSDALEN</City>
        <CountryCode>NO</CountryCode>
      </Address>
      <MobilePhone>98071041</MobilePhone>
    </Receiver>
    <AdditionalParty subClass="GoodsReturnParty">
      <Name>Ola Nordmann</Name>
      <Address>
        <PostalCode>1065</PostalCode>
        <City>OSLO</City>
        <CountryCode>NO</CountryCode>
        <AddressLine>Storgatan 1</AddressLine>
      </Address>
      <MobilePhone>4712345678</MobilePhone>
      <Email>ola.nordmann@someemail.com</Email>
      <ContactName>Ola Nordmann</ContactName>
    </AdditionalParty>
    <AdditionalParty subClass="TransportCompany" partyId="BEX" subPartyId="GLW" />
    <ProductAndService>
      <ProductCode>3270</ProductCode>
    </ProductAndService>
    <GoodsItem>
      <PackageTypeCode>PK</PackageTypeCode>
      <GoodsDescription>Kittens in a sack</GoodsDescription>
      <Package packageId="370722150758796447">
        <GrossWeight unitCode="KGM">1</GrossWeight>
      </Package>
    </GoodsItem>
  </Shipment>
</CreateShipmentRequest>

Responses

HTTP status code 200

Returns a confirmation of successful 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:
  • VALIDATION
  • SYSTEM
  • BAD_REQUEST
ErrorText string Optional
Identities array Optional
PackageId array Required
ShipmentId string Required
ProcessingID string Optional
Status string Optional
Possible values:
  • OK
  • OK_CONFIRMED
  • ERROR
  • VALIDATION_ERROR
  • FORBIDDEN
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:
  • VALIDATION
  • SYSTEM
  • BAD_REQUEST
ErrorText string Optional
Identities array Optional
PackageId array Required
ShipmentId string Required
ProcessingID string Optional
Status string Optional
Possible values:
  • OK
  • OK_CONFIRMED
  • ERROR
  • VALIDATION_ERROR
  • FORBIDDEN
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 booking request consisting of a Shipment with a Goods Item attached. The Goods Item must contain a Package.

A consignment value must not be included as this would imply that the shipment itself, was to be created.

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.
HTTP header Type Description
Accept string Required Specify response format (application/json, application/xml)
Possible values:
  • application/json
  • application/xml
Content-Type string Required Specify request format (application/json, application/xml)
Possible values:
  • application/json
  • application/xml

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="ISO-8859-1"?>
<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 successful 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.

comments powered by Disqus