developer

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

The Shipment API requires 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 params

URI parameter Type Description
createShipmentId boolean

Required. If “true” the API will assign a shipment ID for you and return it in the response..
createPackageId boolean

Required. If “true” the API will assign all package IDs for you and return them in the response..
Header name Type Description
Content-Type string

Required. Specify request format (application/json, application/xml)

Possible values
  • application/json
  • application/xml
Accept string

Required. Specify response format (application/json, application/xml)

Possible values
  • application/json
  • application/xml

Request body

Media Type: application/xml

Field Type Description
CreateShipmentRequest
RequestVersion number

Required. Request version to use


Example: 1
RequestDate datetime

Required. Date and time for when the request was created


Example: 2018-11-22T08:58:52
Shipment object

Required. Structure for the shipment
Field Type Description
Shipment
updateIndicator string

Required. Is this request an original, update or a deletion


Possible values:
  • Original
  • Update
  • Replace
  • Delete

Example: Original
shipmentType string

Required. Type of shipment


Possible values:
  • Instruction
  • Booking
  • Healthcheck

Example: Instruction
ShipmentHeaders object

Required. Structure that handles information for the whole shipment
DateAndTimes array

Required. Date and times for the message, repeatable structure. Several dates are required
Sender object

Required. Structure to hold sender information
Receiver object

Required. Structure to hold receiver information
AdditionalParty array

Required. Additionalparties for the shipment, repeatable. Refer to detailed instructions
ProductAndService object

Required. Product and service codes in addition to value added service structures
DeliveryTerms object

Optional. Terms of delivery
CashOnDelivery object

Optional. Cash on delivery for the shipment
GoodsItem array

Required. Information about the goods being shipped
Field Type Description
ShipmentHeaders
SendersReference string

Required. Senders reference for the shipment


Example: SOA-123222
ReceiversReference string

Optional. Receivers reference for the shipment


Example: SOA-123222
NumberOfPackages string

Required. Total number of packages for the whole shipment across all goodsitems.


Example: 3
AdditionalReference array

Optional. Additional references for the shipment as indicated by referenceType
FreeText array

Optional. Freetext elements
GrossWeight object

Optional. Gross weight for the whole shipment
GrossVolume object

Optional. Gross volume for the whole shipment
Dimensions object

Optional. Dimensions required for the whole shipment
LoadingMetres number

Optional. How many metres of loading space required of a truck’s length


Example: 12
PalletFootPrints integer

Optional. How many pallet footprints are needed for the shipment


Example: 3
HazardPoints integer

Optional. Sum of hazard points for the shipment


Example: 22
ExchangableEquipment object

Optional. Equipment that can be reused, ie. pallets
shipmentId string

Required. Id for the whole shipment, can be retrieved by the API


Example: 70438101412575352
Field Type Description
DateAndTimes
subClass string

Required. Type of datetime


Possible values:
  • DocumentDate
  • PickupRequested
  • PickupEarliest
  • PickupLatest
  • DeliveryRequested
  • DeliveryEarliest
  • DeliveryLatest

Example: DocumentDate
DateTime datetime

Required. Date and Time


Example: 2018-11-22T08:58:52
Field Type Description
Sender
partyId string

Optional. Identifier for the party


Example: BEX
subPartyId string

Optional. Further identification of the party


Example: GLW
Name string

Optional. Party name


Example: Bring
Address object

Optional. Party address
  AddressLine array

Required. Address lines. The first line will be mapped to primary address line


Example: Kong Oscars gate 12
  StateOrRegion string

Optional. State or region, not in use in the nordic countries


Example: Washington DC
  CountryCode string

Required. Country code. Use valid country codes


Example: NO
ContactName string

Optional. Contact name for the party


Example: Atle Thorstensen
Phone string

Optional. Phone


Example: +4712345678
MobilePhone string

Optional. Mobile phone


Example: +4712345678
Email string

Optional. Email


Example: mail@mail.com
Fax string

Optional. Fax


Example: +4712345678
Reference array

Optional. Reference related to the party, can be used for account number of pallet system in Sweden for insatnce.
  ReferenceValue string

Required. Extra Reference


Example: 4440/0189981/WEJ
  referenceType string

Required. ReferenceType


Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER (AAS)
  • 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
Field Type Description
Receiver
partyId string

Optional. Identifier for the party


Example: BEX
subPartyId string

Optional. Further identification of the party


Example: GLW
Name string

Optional. Party name


Example: Bring
Address object

Optional. Party address
  AddressLine array

Required. Address lines. The first line will be mapped to primary address line


Example: Kong Oscars gate 12
  StateOrRegion string

Optional. State or region, not in use in the nordic countries


Example: Washington DC
  CountryCode string

Required. Country code. Use valid country codes


Example: NO
ContactName string

Optional. Contact name for the party


Example: Atle Thorstensen
Phone string

Optional. Phone


Example: +4712345678
MobilePhone string

Optional. Mobile phone


Example: +4712345678
Email string

Optional. Email


Example: mail@mail.com
Fax string

Optional. Fax


Example: +4712345678
Reference array

Optional. Reference related to the party, can be used for account number of pallet system in Sweden for insatnce.
  ReferenceValue string

Required. Extra Reference


Example: 4440/0189981/WEJ
  referenceType string

Required. ReferenceType


Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER (AAS)
  • 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
Field Type Description
AdditionalParty
subClass string

Required. Type of Party


Possible values:
  • DespatchParty
  • DeliveryParty
  • OrderingParty
  • FreightPayer
  • CashOnDeliveryPayee
  • GoodsReturnParty
  • NotifyParty
  • TransportCompany

Example: DeliveryParty
partyId string

Required. Identifier for the party


Example: BEX
subPartyId string

Optional. Further identification for the party


Example: GLW
Name string

Optional. Party name


Example: Rogers antistatiske overledninger
Address object

Optional. Party address
  AddressLine array

Required. Address lines. The first line will be mapped to primary address line


Example: Kong Oscars gate 12
  StateOrRegion string

Optional. State or region, not in use in the nordic countries


Example: Washington DC
  CountryCode string

Required. Country code. Use valid country codes


Example: NO
ContactName string

Optional. Party contact name


Example: Ola Nordmann
Phone string

Optional. Phone


Example: +4712345678
MobilePhone string

Optional. Mobile phone


Example: +4712345678
Email string

Optional. Email


Example: mail@mail.com
Fax string

Optional. Fax


Example: +4712345678
Reference array

Optional. Futher references related to the party


Example: SOA-121232332-AN
  ReferenceValue string

Required. Extra Reference


Example: 4440/0189981/WEJ
  referenceType string

Required. ReferenceType


Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER (AAS)
  • 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
Field Type Description
ProductAndService
ProductCode string

Required. Productcode for shipment, refer to documentation for valid productcodes for this service


Example: COURIER_1H
AdditionalService array

Optional. Additional service codes
  AdditionalServiceCode string

Required. The additional service code for the product


Example: EVARSLING
  ServiceRequirements array

Required. Some AdditionalServiceCodes / valueadded service might require extra information
TariffReference string

Optional. Additional 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: GNCG
NatureOfCargo string

Optional. Indicates if the cargo is out of bound of general expected parameters, dangerous goods or out og gauge


Example: 11
Field Type Description
DeliveryTerms
ConditionCode string

Required. The actual terms for the chosen deliverytermstype


Example: EXW
Location object

Optional. The location where the given deliveryterms (condition) applies (to or from given conditioncode.)
  City string

Required. City where the deliveryterms are valid to or from


Example: Bergen
  CountryCode string

Required. Country where the deliveryterms ar valid to or from


Example: NO
termsType string

Required. Terms valid for this shipment


Possible values:
  • Incoterms
  • Freightterms
  • Combiterms
  • PrePaid
  • ThirdParty

Example: Incoterms
Field Type Description
CashOnDelivery
TransactionIdentifier object

Optional. Senders identifier for the transaction
  identifierType string

Required. Type of cash on delivery


Possible values:
  • PQ
  • SS

Example: PQ
  accountType string

Required. Typeof account to receive payment


Possible values:
  • Bank
  • Bankgiro
  • Plus
  • Post
  • Iban
  • Other

Example: Bank
  Value string

Required. The value to identify where the money should be sent


Example: 1234.12.123456
Amount object

Optional. Amount expected on delivery


Example: 123450
  currencyCode string

Required. Currencycode, valid currency codes allowed


Example: NOK
ControlDigit integer

Optional. Control digit for incoming amount when there is specified a KID number (norwegian only)


Example: 8
DocumentId array

Optional. DocumentIds for Cash on Delivery


Example: SA-46789
MonetaryAccount object

Optional. Description of where the money should be received
codType string

Required. Type of cash on delivery


Possible values:
  • CashOnDelivery
  • PrePaid
  • CreditCard

Example: CashOnDelivery
Field Type Description
GoodsItem
PackageTypeCode string

Required. Types of cargo, packaging of cargo. Either use supported enumeration or UN/ECE Recommendation 21
GoodsDescription string

Optional. Description of goods being shipped


Example: Contains socks
LoadCarrier string

Optional. Transport equipment (pallet, container etc)


Example: EFP
SealId string

Optional. Item sealed for customs etc, number of the seal


Example: 123456
Temperature object

Optional. Temperature requirements for goods being shipped
  Transport object

Required. Temperature requirements during transport
    unitCode string

Required. Unit code for temperature measure


Possible values:
  • CEL
  • FAH

Example: CEL
    minimum string

Optional. Minimum allowed temperature


Example: -8
    maximum string

Optional. Maximum allowed temperature


Example: 4
    Value integer

Required. Specific temperature for transportation of the cargo


Example: 3
  Storage object

Required. Temperature requirements for storage of goods
    unitCode string

Required. Unit code for temperature measure


Possible values:
  • CEL
  • FAH

Example: CEL
    minimum string

Optional. Minimum allowed temperature


Example: -8
    maximum string

Optional. Maximum allowed temperature


Example: 4
    Value integer

Required. Specific temperature for transportation of the cargo


Example: 3
Package array

Required. List of packages being shipped
  rfid boolean

Required. Whether to activate tracking with RFID for the package.
  weight integer

Required. Weight in grams.
  recipientName string

Required. Recipient name.
  postalCode string

Required. A valid Norwegian postal code.
  streetAddress string

Required. Recipient’s street address.
  phoneNumber string

Required. Recipient’s phone number, including country code.


Pattern: \+[0-9 ]+
Example: +4700000000
  email string

Required. Recipient’s email address.
CustomsDetails array

Optional. List of Customs Details for goods being shipped
  Quantity number

Optional. Quantity of packages
  CountryOfOrigin string

Optional. Country of origin of the package
  TariffLineAmount object

Optional. Tariff Line Amount of the package
    currencyCode string

Optional. Currency code of the tariff line
    Value number

Optional. Value of the tariff line
  CustomsArticleNumber string

Optional. Customs Article Number of the package
  GoodsDescription string

Optional. Goods Description of the package
  NetWeight number

Optional. Net weight of the package
DangerousGoods array

Optional. Information about dangerousgoods being shipped
PackingDetails array

Optional. List of Package Details for goods being shipped
  PositionNumber integer

Optional. Position number within Packing Details
  ArticleNumber string

Optional. Articla details of Packing Details
  ArticleDescription string

Optional. Artical description of Packing Details
  ItemDelivered number

Optional. Item Delivered within Packing Details
  ArticlePrice object

Optional. Artical Price of the Packing Details
    currencyCode string

Optional. Quantity of packages
    Value number

Optional. Value of packages
  ItemOrdered number

Optional. Item Ordered within the Packing Details
  ItemBackOrder number

Optional. Item Back Order within Packing Details
  ItemUnity string

Optional. Item Unity within Packing Details
Field Type Description
MonetaryAccount
AccountNumber object

Required. Account number to receive payment
  accountType string

Required. Type of account to receive payment on delivery


Possible values:
  • Bank
  • Bankgiro
  • Plus
  • Post
  • Iban
  • Other
  Value string

Required. Actual account number


Example: 4567.45.12345
SwiftCode string

Required. Swift code for international transfers


Example: DNBANOKK
BankName string

Required. Bank where account is created


Example: DNB
AccountHolderName string

Required. Name of the owner of the account


Example: Ola Nordmann
Field Type Description
DangerousGoods
UNDGInformation object

Required. United nations dangerous goods information
  HazardIdentifier string

Optional. United nations dangerous goods hazard identifier


Example: 1.1D
  FlashpointDescription string

Optional. Flashpoint for dangerous goods


Example: BLACK POWDER, granulated or in powderform
Flashpoint object

Required. Flashpointinformation for dangerousgoods (when will the item become volatile?)
  unitCode string

Optional. Unit code for flashpoint


Possible values:
  • CEL
  • FAH

Example: CEL
  Value integer

Optional. Value when flashpoint occurs/ignites


Example: 18
HazardClass string

Optional. Classification of hazard


Example: 4.1
AdditionalHazard string

Optional. Additional codes for hazard


Example: 2.3(8)
PackingGroup string

Optional. Packing danger level code, roman numeral between 1 and 3


Example: II
Measures array

Optional. Measures for Dangerous Goods
  Measure object

Optional. Measurements for goods
    unitCode string

Optional. Unit code for measure


Example: DMQ
    Value number

Optional. Measure value


Example: 1.22
  subClass string

Optional.


Example: NetHazardWeight
TechnicalName string

Optional. Technical name of hazard


Example: KALSIUMRESINAT, SINTRET
Restrictions array

Optional. Restrictions when carrying these hazardous goods
  restrictionType string

Optional. Type of restriction


Possible values:
  • Tunnel

Example: Tunnel
  Value string

Optional. Freetext 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
HazardPoints integer

Optional. Points for this hazard. Calculated from factor for dangerousgoods multiplied by amount in kg / dm3 for each material in cargo


Example: 10
regulatonCode string

Optional. Regulation 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>

Media Type: application/json

Field Type Description
CreateShipmentRequest
RequestVersion number

Required. Request version to use


Example: 1
RequestDate datetime

Required. Date and time for when the request was created


Example: 2018-11-22T08:58:52
Shipment object

Required. Structure for the shipment
Field Type Description
Shipment
updateIndicator string

Required. Is this request an original, update or a deletion


Possible values:
  • Original
  • Update
  • Replace
  • Delete

Example: Original
shipmentType string

Required. Type of shipment


Possible values:
  • Instruction
  • Booking
  • Healthcheck

Example: Instruction
ShipmentHeaders object

Required. Structure that handles information for the whole shipment
DateAndTimes array

Required. Date and times for the message, repeatable structure. Several dates are required
Sender object

Required. Structure to hold sender information
Receiver object

Required. Structure to hold receiver information
AdditionalParty array

Required. Additionalparties for the shipment, repeatable. Refer to detailed instructions
ProductAndService object

Required. Product and service codes in addition to value added service structures
DeliveryTerms object

Optional. Terms of delivery
CashOnDelivery object

Optional. Cash on delivery for the shipment
GoodsItem array

Required. Information about the goods being shipped
Field Type Description
ShipmentHeaders
SendersReference string

Required. Senders reference for the shipment


Example: SOA-123222
ReceiversReference string

Optional. Receivers reference for the shipment


Example: SOA-123222
NumberOfPackages string

Required. Total number of packages for the whole shipment across all goodsitems.


Example: 3
AdditionalReference array

Optional. Additional references for the shipment as indicated by referenceType
FreeText array

Optional. Freetext elements
GrossWeight object

Optional. Gross weight for the whole shipment
GrossVolume object

Optional. Gross volume for the whole shipment
Dimensions object

Optional. Dimensions required for the whole shipment
LoadingMetres number

Optional. How many metres of loading space required of a truck’s length


Example: 12
PalletFootPrints integer

Optional. How many pallet footprints are needed for the shipment


Example: 3
HazardPoints integer

Optional. Sum of hazard points for the shipment


Example: 22
ExchangableEquipment object

Optional. Equipment that can be reused, ie. pallets
shipmentId string

Required. Id for the whole shipment, can be retrieved by the API


Example: 70438101412575352
Field Type Description
DateAndTimes
subClass string

Required. Type of datetime


Possible values:
  • DocumentDate
  • PickupRequested
  • PickupEarliest
  • PickupLatest
  • DeliveryRequested
  • DeliveryEarliest
  • DeliveryLatest

Example: DocumentDate
DateTime datetime

Required. Date and Time


Example: 2018-11-22T08:58:52
Field Type Description
Sender
partyId string

Optional. Identifier for the party


Example: BEX
subPartyId string

Optional. Further identification of the party


Example: GLW
Name string

Optional. Party name


Example: Bring
Address object

Optional. Party address
  AddressLine array

Required. Address lines. The first line will be mapped to primary address line


Example: Kong Oscars gate 12
  StateOrRegion string

Optional. State or region, not in use in the nordic countries


Example: Washington DC
  CountryCode string

Required. Country code. Use valid country codes


Example: NO
ContactName string

Optional. Contact name for the party


Example: Atle Thorstensen
Phone string

Optional. Phone


Example: +4712345678
MobilePhone string

Optional. Mobile phone


Example: +4712345678
Email string

Optional. Email


Example: mail@mail.com
Fax string

Optional. Fax


Example: +4712345678
Reference array

Optional. Reference related to the party, can be used for account number of pallet system in Sweden for insatnce.
  ReferenceValue string

Required. Extra Reference


Example: 4440/0189981/WEJ
  referenceType string

Required. ReferenceType


Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER (AAS)
  • 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
Field Type Description
Receiver
partyId string

Optional. Identifier for the party


Example: BEX
subPartyId string

Optional. Further identification of the party


Example: GLW
Name string

Optional. Party name


Example: Bring
Address object

Optional. Party address
  AddressLine array

Required. Address lines. The first line will be mapped to primary address line


Example: Kong Oscars gate 12
  StateOrRegion string

Optional. State or region, not in use in the nordic countries


Example: Washington DC
  CountryCode string

Required. Country code. Use valid country codes


Example: NO
ContactName string

Optional. Contact name for the party


Example: Atle Thorstensen
Phone string

Optional. Phone


Example: +4712345678
MobilePhone string

Optional. Mobile phone


Example: +4712345678
Email string

Optional. Email


Example: mail@mail.com
Fax string

Optional. Fax


Example: +4712345678
Reference array

Optional. Reference related to the party, can be used for account number of pallet system in Sweden for insatnce.
  ReferenceValue string

Required. Extra Reference


Example: 4440/0189981/WEJ
  referenceType string

Required. ReferenceType


Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER (AAS)
  • 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
Field Type Description
AdditionalParty
subClass string

Required. Type of Party


Possible values:
  • DespatchParty
  • DeliveryParty
  • OrderingParty
  • FreightPayer
  • CashOnDeliveryPayee
  • GoodsReturnParty
  • NotifyParty
  • TransportCompany

Example: DeliveryParty
partyId string

Required. Identifier for the party


Example: BEX
subPartyId string

Optional. Further identification for the party


Example: GLW
Name string

Optional. Party name


Example: Rogers antistatiske overledninger
Address object

Optional. Party address
  AddressLine array

Required. Address lines. The first line will be mapped to primary address line


Example: Kong Oscars gate 12
  StateOrRegion string

Optional. State or region, not in use in the nordic countries


Example: Washington DC
  CountryCode string

Required. Country code. Use valid country codes


Example: NO
ContactName string

Optional. Party contact name


Example: Ola Nordmann
Phone string

Optional. Phone


Example: +4712345678
MobilePhone string

Optional. Mobile phone


Example: +4712345678
Email string

Optional. Email


Example: mail@mail.com
Fax string

Optional. Fax


Example: +4712345678
Reference array

Optional. Futher references related to the party


Example: SOA-121232332-AN
  ReferenceValue string

Required. Extra Reference


Example: 4440/0189981/WEJ
  referenceType string

Required. ReferenceType


Possible values:
  • DESPATCH_ADVICE_NUMBER (AAK)
  • TRANSPORT_DOCUMENT_NUMBER (AAS)
  • 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
Field Type Description
ProductAndService
ProductCode string

Required. Productcode for shipment, refer to documentation for valid productcodes for this service


Example: COURIER_1H
AdditionalService array

Optional. Additional service codes
  AdditionalServiceCode string

Required. The additional service code for the product


Example: EVARSLING
  ServiceRequirements array

Required. Some AdditionalServiceCodes / valueadded service might require extra information
TariffReference string

Optional. Additional 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: GNCG
NatureOfCargo string

Optional. Indicates if the cargo is out of bound of general expected parameters, dangerous goods or out og gauge


Example: 11
Field Type Description
DeliveryTerms
ConditionCode string

Required. The actual terms for the chosen deliverytermstype


Example: EXW
Location object

Optional. The location where the given deliveryterms (condition) applies (to or from given conditioncode.)
  City string

Required. City where the deliveryterms are valid to or from


Example: Bergen
  CountryCode string

Required. Country where the deliveryterms ar valid to or from


Example: NO
termsType string

Required. Terms valid for this shipment


Possible values:
  • Incoterms
  • Freightterms
  • Combiterms
  • PrePaid
  • ThirdParty

Example: Incoterms
Field Type Description
CashOnDelivery
TransactionIdentifier object

Optional. Senders identifier for the transaction
  identifierType string

Required. Type of cash on delivery


Possible values:
  • PQ
  • SS

Example: PQ
  accountType string

Required. Typeof account to receive payment


Possible values:
  • Bank
  • Bankgiro
  • Plus
  • Post
  • Iban
  • Other

Example: Bank
  Value string

Required. The value to identify where the money should be sent


Example: 1234.12.123456
Amount object

Optional. Amount expected on delivery


Example: 123450
  currencyCode string

Required. Currencycode, valid currency codes allowed


Example: NOK
ControlDigit integer

Optional. Control digit for incoming amount when there is specified a KID number (norwegian only)


Example: 8
DocumentId array

Optional. DocumentIds for Cash on Delivery


Example: SA-46789
MonetaryAccount object

Optional. Description of where the money should be received
codType string

Required. Type of cash on delivery


Possible values:
  • CashOnDelivery
  • PrePaid
  • CreditCard

Example: CashOnDelivery
Field Type Description
GoodsItem
PackageTypeCode string

Required. Types of cargo, packaging of cargo. Either use supported enumeration or UN/ECE Recommendation 21
GoodsDescription string

Optional. Description of goods being shipped


Example: Contains socks
LoadCarrier string

Optional. Transport equipment (pallet, container etc)


Example: EFP
SealId string

Optional. Item sealed for customs etc, number of the seal


Example: 123456
Temperature object

Optional. Temperature requirements for goods being shipped
  Transport object

Required. Temperature requirements during transport
    unitCode string

Required. Unit code for temperature measure


Possible values:
  • CEL
  • FAH

Example: CEL
    minimum string

Optional. Minimum allowed temperature


Example: -8
    maximum string

Optional. Maximum allowed temperature


Example: 4
    Value integer

Required. Specific temperature for transportation of the cargo


Example: 3
  Storage object

Required. Temperature requirements for storage of goods
    unitCode string

Required. Unit code for temperature measure


Possible values:
  • CEL
  • FAH

Example: CEL
    minimum string

Optional. Minimum allowed temperature


Example: -8
    maximum string

Optional. Maximum allowed temperature


Example: 4
    Value integer

Required. Specific temperature for transportation of the cargo


Example: 3
Package array

Required. List of packages being shipped
  rfid boolean

Required. Whether to activate tracking with RFID for the package.
  weight integer

Required. Weight in grams.
  recipientName string

Required. Recipient name.
  postalCode string

Required. A valid Norwegian postal code.
  streetAddress string

Required. Recipient’s street address.
  phoneNumber string

Required. Recipient’s phone number, including country code.


Pattern: \+[0-9 ]+
Example: +4700000000
  email string

Required. Recipient’s email address.
CustomsDetails array

Optional. List of Customs Details for goods being shipped
  Quantity number

Optional. Quantity of packages
  CountryOfOrigin string

Optional. Country of origin of the package
  TariffLineAmount object

Optional. Tariff Line Amount of the package
    currencyCode string

Optional. Currency code of the tariff line
    Value number

Optional. Value of the tariff line
  CustomsArticleNumber string

Optional. Customs Article Number of the package
  GoodsDescription string

Optional. Goods Description of the package
  NetWeight number

Optional. Net weight of the package
DangerousGoods array

Optional. Information about dangerousgoods being shipped
PackingDetails array

Optional. List of Package Details for goods being shipped
  PositionNumber integer

Optional. Position number within Packing Details
  ArticleNumber string

Optional. Articla details of Packing Details
  ArticleDescription string

Optional. Artical description of Packing Details
  ItemDelivered number

Optional. Item Delivered within Packing Details
  ArticlePrice object

Optional. Artical Price of the Packing Details
    currencyCode string

Optional. Quantity of packages
    Value number

Optional. Value of packages
  ItemOrdered number

Optional. Item Ordered within the Packing Details
  ItemBackOrder number

Optional. Item Back Order within Packing Details
  ItemUnity string

Optional. Item Unity within Packing Details
Field Type Description
MonetaryAccount
AccountNumber object

Required. Account number to receive payment
  accountType string

Required. Type of account to receive payment on delivery


Possible values:
  • Bank
  • Bankgiro
  • Plus
  • Post
  • Iban
  • Other
  Value string

Required. Actual account number


Example: 4567.45.12345
SwiftCode string

Required. Swift code for international transfers


Example: DNBANOKK
BankName string

Required. Bank where account is created


Example: DNB
AccountHolderName string

Required. Name of the owner of the account


Example: Ola Nordmann
Field Type Description
DangerousGoods
UNDGInformation object

Required. United nations dangerous goods information
  HazardIdentifier string

Optional. United nations dangerous goods hazard identifier


Example: 1.1D
  FlashpointDescription string

Optional. Flashpoint for dangerous goods


Example: BLACK POWDER, granulated or in powderform
Flashpoint object

Required. Flashpointinformation for dangerousgoods (when will the item become volatile?)
  unitCode string

Optional. Unit code for flashpoint


Possible values:
  • CEL
  • FAH

Example: CEL
  Value integer

Optional. Value when flashpoint occurs/ignites


Example: 18
HazardClass string

Optional. Classification of hazard


Example: 4.1
AdditionalHazard string

Optional. Additional codes for hazard


Example: 2.3(8)
PackingGroup string

Optional. Packing danger level code, roman numeral between 1 and 3


Example: II
Measures array

Optional. Measures for Dangerous Goods
  Measure object

Optional. Measurements for goods
    unitCode string

Optional. Unit code for measure


Example: DMQ
    Value number

Optional. Measure value


Example: 1.22
  subClass string

Optional.


Example: NetHazardWeight
TechnicalName string

Optional. Technical name of hazard


Example: KALSIUMRESINAT, SINTRET
Restrictions array

Optional. Restrictions when carrying these hazardous goods
  restrictionType string

Optional. Type of restriction


Possible values:
  • Tunnel

Example: Tunnel
  Value string

Optional. Freetext 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
HazardPoints integer

Optional. Points for this hazard. Calculated from factor for dangerousgoods multiplied by amount in kg / dm3 for each material in cargo


Example: 10
regulatonCode string

Optional. Regulation 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"
        }
      }
    ]
  }
}

Responses

HTTP status code 200

Returns a confirmation of successfull delivery and package IDs / shipment IDs if requested.

Media Type: application/xml

Field Type Description
CreateShipmentResponse
Status string

Optional.


Possible values:
  • OK
  • OK_CONFIRMED
  • ERROR
  • VALIDATION_ERROR
  • FORBIDDEN
StatusText string

Optional.
Errors array

Optional.
  Error string

Optional. Error type


Possible values:
  • VALIDATION
  • SYSTEM
  • BAD_REQUEST
  ErrorText string

Optional.
Identities array

Optional.
  PackageId array

Required.
  ShipmentId string

Required.
ProcessingID string

Optional.
EndpointProcessingID 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>

Media Type: application/json

Field Type Description
CreateShipmentResponse
Status string

Optional.


Possible values:
  • OK
  • OK_CONFIRMED
  • ERROR
  • VALIDATION_ERROR
  • FORBIDDEN
StatusText string

Optional.
Errors array

Optional.
  Error string

Optional. Error type


Possible values:
  • VALIDATION
  • SYSTEM
  • BAD_REQUEST
  ErrorText string

Optional.
Identities array

Optional.
  PackageId array

Required.
  ShipmentId string

Required.
ProcessingID string

Optional.
EndpointProcessingID 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"
  }
}

HTTP status code 250

Sample request to book a Bring Express Courier shipment.

Media Type: application/xml

Media Type: application/json

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 params

URI parameter Type Description
createShipmentId boolean

Required. If “true” the API will assign a shipment ID for you and return it in the response..
createPackageId boolean

Required. If “true” the API will assign all package IDs for you and return them in the response..
Header name Type Description
Content-Type string

Required. Specify request format (application/json, application/xml)

Possible values
  • application/json
  • application/xml
Accept string

Required. Specify response format (application/json, application/xml)

Possible values
  • application/json
  • application/xml

Request body

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>

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"
          }
        ]
      }
    ]
  }
}

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.