Skip to main content

Shipping Guide API

The Shipping Guide API provides available services for a given combination of sender and recipient locations, including estimated delivery times, prices and environmental data. It also returns logo and human readable service descriptions that can be shown in your checkout. Available services are based on your agreement with Bring (i.e. the customer numbers attached to your user).

Authentication

To integrate with the Bring APIs, you will need a Mybring user account with an API key. Information about prerequisites and authentication headers can be found on the general API Getting Started page.

Rate limiting

Clients exceeding 120 requests per second will be throttled, and the response will contain http status code 429. If you have a use case requiring rates above the limit, please contact developer-booking@bring.com for assistance.

Formats

Both XML and JSON over HTTP. The GET request only supports single consignments, while the POST requests can be used for multiple consignments.

Special topics

Tips and guides

The importance of provided shipping date

Providing the actual shipping date in the request is a prerequisite for getting the correct lead times, as the lead time is always calculated from the day and time when the parcel arrives at a Bring terminal. It is recommended to read this guide for a better understanding of how the provided shipping date affects the returned lead time.

NOTE: In absence of a shipping date set by the user, the Shipping Guide API will default to now. If shipping date is set to now, lead times will be calculated on the assumption that the packages has just arrived at a terminal.

Endpoints

Base URL 
https://api.bring.com/shippingguide
Usage Method Endpoint
Fetch shipping details POST /api/v2/products

OpenAPI document

https://api.bring.com/shippingguide/api-docs

Fetch shipping details

post 
                  https://api.bring.com/shippingguide/api/v2/products

Use this endpoint to get expected delivery, prices, service categories and additional information.

Measurements

For cargo services(5100, 5300, 9100, CARGO), Weight is mandatory and one of the Volume / Load Meter / Dimensions / Number of Pallets is mandatory.

Note: The prices for our revised services depends on volumetric weight: 5000, 5100, 5300, 5600, 5800, 4850 plus return services 9000, 9100, 9300 or 9600. For these services, dimensions (L/W/H) is needed to calculate the expected price correctly. Dimensions are also used to decide if handling fee or specialgoods fee will apply to the shipment. You might leave dimensions empty in your request, but be aware that returned prices might be incorrect.

Request

header parameters

X-Mybring-API-Uid
Required
Description
Mybring login ID
Type
string
X-Mybring-API-Key
Required
Description
Your user's API key
Type
string
Accept
Description
Desired output media type
Type
string
Enum
application/json
application/xml
Default
application/json

Body schema

Required
List of consignments
array of objects
Additional services to be added
array of objects
id
Additional service id
string
leadTimeFromCustomerInMinutes
Customer internal lead time before consignment is ready for shipment. Availability of same day delivery is calculated based on now() + number of minutes configured. So if now() is 12:00 and lead time is set to 120, 14:00 is used as starting point and compared to route cut-offs for same day delivery availability. Required when calculating same day delivery (VAS 2012)
integer <int32>
sortingAreas
Sorting areas that should be used when calculating same day delivery (VAS 2012). See also available sorting areas for details.
string
addressLine
The street name and number the consignment is to be delivered to
string
If dangerous goods are to be part of the consignment, the ADR-code(s) specifying the dangerous goods type(s) has to be provided
object
unNumbers
Required
List of dangerous goods ADR-codes
array of strings
List of dangerous goods ADR-codes
string
fromCountryCode
Two-letter ISO-3166-1 country code of which consignment is sent from
string
fromPostalCode
The postal code the consignment is sent from
string
id
Your internal reference to this consignment (you may calculate several consignment at the same time)
string
incoterms
International commercial terms
string
List of all packages in the consignment
array of objects
grossWeight
The weight of the package in gram
number <double>
height
Height of the package in centimeters
number <double>
id
Your internal reference to this package (you may estimate several packages at the same time)
string
length
Length of the package in centimeters. The highest value of height, width and length will always be used as length
number <double>
loadMeter
Loading meters. Only applicable for cargo products
number <double>
nonStackable
Set to true if you know the package/pallet is non-stackable
boolean
numberOfPallets
Number of pallets. Only applicable for cargo products
integer <int32>
volume
The volume of the package in cubic decimeters
string
volumeSpecial
Set to true if you know the package price will be adjusted for special volume. Typically used for roll or other weirdly shaped packages.
boolean
width
Width of the package in centimeters
number <double>
pickupPointId
The pickup point id to which the consignment is to be shipped to. Only relevant for parcel products
string
List of pickup points for which estimated delivery time should be calculated for (if value of 'WithEstimatedDeliveryTime' is true). If not provided, the default pickup point for the receiver's postal code will be used.
array of objects
id
Pickup point id
string
List of all services price and lead times should be calculated for
array of objects
Payer
Which party will pay for the shipment
string
Enum
SENDER
RECEIVER
THIRD_PARTY
customerNumber
The mybring API customer number. Different customer numbers exist for different services, therefore the customer number is specified for each requested service. If a valid customer number is supplied, net prices will be returned for the specified service. Otherwise list (gross) prices is returned.
string
id
The service id
string
nonStandardCourierService
Required field when requesting non standard courier products. Represents the customer specific service code
string
The date (and optionally time) the consignment will be shipped (used for computing estimated delivery date). NOTE: The lead time calculation interprets the provided date & time as the time when the consignment has been scanned at the terminal. If not provided, now() will be used
object
day
Required
string
hour
string
minute
string
month
Required
string
year
Required
string
toCity
The city the consignment is to be delivered to
string
toCountryCode
Two-letter ISO-3166-1 country code of which consignment is sent to
string
toPostalCode
The postal code the consignment is to be delivered to
string
edi
Should the parcel be registered using EDI when shipped. Note that this flag may affect price and which services are available
boolean
language
Language in which human-readable message should be returned.
string
Enum
NO
SE
SV
DA
EN
numberOfAlternativeDeliveryDates
Number of alternative delivery dates to be suggested
integer <int32>
postingAtPostoffice
Will the parcel be delivered at a post office when shipped
boolean
withEnvironmentalData
Return environmental data about fossil free and electric transportation used on the shipments transport legs
boolean
withEstimatedDeliveryTime
Extended lead time information, including predicted arrival time at pickup point. Only supported for a limited set of services
boolean
withExpectedDelivery
Controls whether lead times should be calculated or not
boolean
withGuiInformation
Return detailed information about requested service(s)
boolean
withPrice
Controls whether prices should be calculated. If customerNumber is supplied, the authenticated user requires the financial role with the provided customer
boolean
withUniqueAlternateDeliveryDates
Return unique delivery dates
boolean
object
Required
List of consignments
array wrapped
List of consignments
object
Additional services to be added
array wrapped
Additional service
object
Id
Required
Additional service id
string
LeadTimeFromCustomerInMinutes
Customer internal lead time before consignment is ready for shipment. Availability of same day delivery is calculated based on now() + number of minutes configured. So if now() is 12:00 and lead time is set to 120, 14:00 is used as starting point and compared to route cut-offs for same day delivery availability. Required when calculating same day delivery (VAS 2012)
integer <int32>
SortingAreas
Sorting areas that should be used when calculating same day delivery (VAS 2012). See also available sorting areas for details.
string
AddressLine
The street name and number the consignment is to be delivered to
string
If dangerous goods are to be part of the consignment, the ADR-code(s) specifying the dangerous goods type(s) has to be provided
object
Required
List of dangerous goods ADR-codes
array
UnNumber
List of dangerous goods ADR-codes
string
FromCountryCode
Required
Two-letter ISO-3166-1 country code of which consignment is sent from
string
FromPostalCode
Required
The postal code the consignment is sent from
string
id
Your internal reference to this consignment (you may calculate several consignment at the same time)
string attribute
Incoterms
International commercial terms
string
Required
List of all packages in the consignment
array wrapped
Describing the package details
object
GrossWeight
The weight of the package in gram
number <double>
Height
Height of the package in centimeters
number <double>
id
Your internal reference to this package (you may estimate several packages at the same time)
string attribute
Length
Length of the package in centimeters. The highest value of height, width and length will always be used as length
number <double>
LoadMeter
Loading meters. Only applicable for cargo products
number <double>
NonStackable
Set to true if you know the package/pallet is non-stackable
boolean
NumberOfPallets
Number of pallets. Only applicable for cargo products
integer <int32>
Volume
The volume of the package in cubic decimeters
string
VolumeSpecial
Set to true if you know the package price will be adjusted for special volume. Typically used for roll or other weirdly shaped packages.
boolean
Width
Width of the package in centimeters
number <double>
PickupPointId
The pickup point id to which the consignment is to be shipped to. Only relevant for parcel products
string
List of pickup points for which estimated delivery time should be calculated for (if value of 'WithEstimatedDeliveryTime' is true). If not provided, the default pickup point for the receiver's postal code will be used.
array wrapped
Pickup point
object
Id
Required
Pickup point id
string
Required
List of all services price and lead times should be calculated for
array wrapped
A service you want price and lead times calculated for
object
Payer
Which party will pay for the shipment
string
Enum
SENDER
RECEIVER
THIRD_PARTY
CustomerNumber
The mybring API customer number. Different customer numbers exist for different services, therefore the customer number is specified for each requested service. If a valid customer number is supplied, net prices will be returned for the specified service. Otherwise list (gross) prices is returned.
string
Id
Required
The service id
string
NonStandardCourierService
Required field when requesting non standard courier products. Represents the customer specific service code
string
The date (and optionally time) the consignment will be shipped (used for computing estimated delivery date). NOTE: The lead time calculation interprets the provided date & time as the time when the consignment has been scanned at the terminal. If not provided, now() will be used
object
Day
Required
string
Hour
string
Minute
string
Month
Required
string
Year
Required
string
ToCity
The city the consignment is to be delivered to
string
ToCountryCode
Required
Two-letter ISO-3166-1 country code of which consignment is sent to
string
ToPostalCode
Required
The postal code the consignment is to be delivered to
string
EDI
Should the parcel be registered using EDI when shipped. Note that this flag may affect price and which services are available
boolean
Language
Language in which human-readable message should be returned.
string
Enum
NO
SE
SV
DA
EN
NumberOfAlternativeDeliveryDates
Number of alternative delivery dates to be suggested
integer <int32>
PostingAtPostoffice
Will the parcel be delivered at a post office when shipped
boolean
WithEnvironmentalData
Return environmental data about fossil free and electric transportation used on the shipments transport legs
boolean
WithEstimatedDeliveryTime
Extended lead time information, including predicted arrival time at pickup point. Only supported for a limited set of services
boolean
WithExpectedDelivery
Controls whether lead times should be calculated or not
boolean
WithGuiInformation
Return detailed information about requested service(s)
boolean
WithPrice
Controls whether prices should be calculated. If customerNumber is supplied, the authenticated user requires the financial role with the provided customer
boolean
WithUniqueAlternateDeliveryDates
Return unique delivery dates
boolean

Responses

200 OK

Schema

List of consignments
array of objects
consignmentId
The consignment id
string

The requested services results.

ShippingGuide will never remove services from the request if unable to calculate any of the requested data. It will either return the requested data or a service level error code along with a description.

array of objects
customerNumber
The mybring API customer number
string
EDI information required to make EDI bookings
object
Cargo service data required to make EDI booking
object
cargoProduct
Cargo product
string
cargoTransportType
Cargo transport type
string
dispatchAgentNumber
Required
Dispatch agent number
string
Courier service data required to make EDI booking
object
department
Required
Department
string
numberOfKilometers
Number of kilometers
string
operationsID
Required
Operations id
string
orderStartTime
Order start time
string
Quickpack service data required to make EDI booking
object
orderStartTime
Order start time
string
Quickpack service data required to make EDI booking while using UPS as a transport service provider
object
bringStreamIndicator
Required
Bring stream indicator
string
leg1CustomerNumber
Required
Transport leg 1 customer number
string
leg1TransportServiceProvider
Required
Transport leg 1 service provider
string
stateProvinceCounty
Required
State/Province/County
string
upsAccountNumber
Required
UPS account number
string
upsBillingOption
Required
UPS billing option
string
upsClassOfService
Required
UPS class of service
string
upsDocumentationIndicator1
Required
UPS documentation indicator 1
string
upsDocumentationIndicator2
Required
UPS documentation indicator 2
string
upsRoutingCode
Required
UPS routing code
string
upsRoutingCodeVersion
Required
UPS routing code version
string
upsServiceIcon
Required
UPS service icon
string
upsServiceIndicator
Required
UPS service indicator
string
upsServiceTitle
Required
UPS service title
string
upsSignatureRequiredString
Required
UPS signature required
string
Environmental profile of transport legs. Returned when withEnvironmentalData is requested and requested service is supported.
array of objects
description
Human readable description
string
Fossil free vehicle details
object
bio
Share of bio-diesel vehicles used on this transportation leg
number <double>
electric
Share of electric vehicles used on this transportation leg
number <double>
fossilFree
If true, shipment is transported by fossil free vehicles on this leg
boolean
nordicSwanEcoLabel
If true, shipment that is transported is nordic swan eco labeled
boolean
transportLeg
Transport leg
string
Enum
LAST_MILE
LINE_HAUL
FIRST_MILE
Errors related to requested service, if any
array of objects
code
Error code
string
Enum
NOT_FOUND
FORBIDDEN
CONFLICT
UNAUTHORIZED
INVALID_ARGUMENT
INVALID_MEASUREMENTS
INTERNAL_ERROR
description
Human-readable description of the error that occurred
string
Estimated delivery times at provided pickup point ids. Only relevant when withEstimatedDeliveryTime flag is set for services delivered to pickup point.
array of objects
deliveryEndTime
Delivery time window end time at the specified pickup point
string
deliveryStartTime
Delivery time window start time at the specified pickup point
string
formattedExpectedDeliveryDate
Formatted expected delivery date
string
pickupPointId
Pickup point id. Either provided in the request or fetched as default pickup point for recipient postal code
string
pickupPointName
Pickup point name
string
shippingDate
Formatted shipping date
string
workingDays
Number of working days until delivery
string
Expected delivery details for the shipment
object
Alternative delivery dates
array of objects
Delivery date
object
day
Required
string
hour
string
minute
string
month
Required
string
array of objects
object
hour
Required
string
minute
Required
string
object
hour
Required
string
minute
Required
string
year
Required
string
formattedExpectedDeliveryDate
Formatted expected delivery date
string <dd.MM.yyyy>
Delivery date
object
day
Required
string
hour
string
minute
string
month
Required
string
array of objects
object
hour
Required
string
minute
Required
string
object
hour
Required
string
minute
Required
string
year
Required
string
workingDays
Number of working days until delivery
string
bookingCutoffTime
The deadline for booking a shipment to the given destination. Only relevant for OIL_EXPRESS.
string <HH:mm>
Delivery date
object
day
Required
string
hour
string
minute
string
month
Required
string
array of objects
object
hour
Required
string
minute
Required
string
object
hour
Required
string
minute
Required
string
year
Required
string
Delivery date
object
day
Required
string
hour
string
minute
string
month
Required
string
array of objects
object
hour
Required
string
minute
Required
string
object
hour
Required
string
minute
Required
string
year
Required
string
formattedEarliestPickupDate
Formatted earliest pickup date
string <dd.MM.yyyy>
formattedExpectedDeliveryDate
Expected delivery date/time formatted as dd.MM.YYYY HH:mm
string <dd.MM.YYYY HH:mm>
Same day delivery details. Only relevant for services supporting delivery today or tomorrow like 5600 + 2012 VAS
object
Required
Delivery date
object
day
Required
string
hour
string
minute
string
month
Required
string
array of objects
object
hour
Required
string
minute
Required
string
object
hour
Required
string
minute
Required
string
year
Required
string
formattedDeliveryDate
Required
Formatted delivery date
string <dd.MM.yyyy>
Route information
object
routeId
Required
Route id
string
routeName
Required
Route name
string
userMessage
If there is known inaccuracy in the calculated lead time, this message will contain a human readable text explaining the deviation
string
workingDays
Required
The expected number of working days to deliver the shipment
string
greenDelivery
Indicates whether the shipment is being delivered with fossil free transportation or not. Only relevant for HD-services
boolean
Detailed description of the requested service. All texts are in the requested language whenever translations are available.
object
closestPickupPoint
Default pickup point for the requested toPostalCode. Only relevant for pickup point services SERVICEPAKKE, 5800 and 3067
string
deliveryType
Required
Service delivery type
string
descriptionText
Required
Service description
string
displayName
Required
Service display name
string
environmentalLogoUrl
URL to logo for labelling service as environmental friendly
string
environmentalTagUrl
URL to tag for labelling services as environmental friendly
string
helpText
Required
Service help text
string
logo
Logo type to be used with this service
string
Enum
POSTEN
BRING
logoUrl
URL to a suitable logo in svg format
string
mainDisplayCategory
Required
Main display category
string
maxWeightInKgs
Required
Service max weight in kgs
string
productName
Required
Service name
string
productURL
Required
URL to service description page
string
shortName
Required
Service short name
string
subDisplayCategory
Required
Sub display category
string
trackable
Is this service trackable
boolean
id
The service id
string
Requested service and additional services prices
object
Net (agreeemnt) price for shipping the service. Will only be calculated if a valid customer number has been supplied for the service
object
Additional service prices
array of objects
additionalServiceCodeFromProductionSystem
string
additionalServiceDescription
string
additionalServiceId
string
Price with additional services
object
amountWithVAT
Required
string
amountWithoutVAT
Required
string
vat
Required
string
Agreement price (contract/agreement) attributes used for net prices used for producing EDI. Never set for list prices.
object
agreementNumber
string
Cargo agreement price attributes
array of objects
agreementName
Agreement name
string
agreementNumber
Agreement number
string
price
Agreement price
string
subAgreementName
Sub agreement name
string
subAgreementNumber
Sub agreement number
string
currencyCode
Currency code for all prices
string
netPriceFailed
Only used for net prices in the scenario where net price calculation fails. If true, returned net price will be equal to list price, or a partially discounted price (i.e. a value between the list price and the correct net price)
boolean
Required
Price with additional services
object
amountWithVAT
Required
string
amountWithoutVAT
Required
string
vat
Required
string
Required
Price with additional services
object
amountWithVAT
Required
string
amountWithoutVAT
Required
string
vat
Required
string
Net (agreeemnt) price for shipping the service. Will only be calculated if a valid customer number has been supplied for the service
object
Additional service prices
array of objects
additionalServiceCodeFromProductionSystem
string
additionalServiceDescription
string
additionalServiceId
string
Price with additional services
object
amountWithVAT
Required
string
amountWithoutVAT
Required
string
vat
Required
string
Agreement price (contract/agreement) attributes used for net prices used for producing EDI. Never set for list prices.
object
agreementNumber
string
Cargo agreement price attributes
array of objects
agreementName
Agreement name
string
agreementNumber
Agreement number
string
price
Agreement price
string
subAgreementName
Sub agreement name
string
subAgreementNumber
Sub agreement number
string
currencyCode
Currency code for all prices
string
netPriceFailed
Only used for net prices in the scenario where net price calculation fails. If true, returned net price will be equal to list price, or a partially discounted price (i.e. a value between the list price and the correct net price)
boolean
Required
Price with additional services
object
amountWithVAT
Required
string
amountWithoutVAT
Required
string
vat
Required
string
Required
Price with additional services
object
amountWithVAT
Required
string
amountWithoutVAT
Required
string
vat
Required
string
Price zone details
object
totalZoneCount
The total number of price zones used during price calculation
integer <int32>
productionCode
Backend system production code. This code is required when producing valid EDI messages during ordering.
string
shippingWeight
The calculated volumetric weight (chargeable weight)
number <double>
sortingCode
Sorting code. Only relevant for home delivery services with Norway as destination.
string
sortingDirection
Sorting direction. Only relevant for home delivery services with Norway as destination.
string
Warnings related to the requested service, if any. Warnings could explain why some parts of the requested data is missing
array of objects
code
Warning code
string
Enum
NO_EXPECTED_DELIVERY
NO_PRICE_INFORMATION
ADDITIONAL_SERVICE_NOT_APPLICABLE
ESTIMATED_DELIVERY_TIME_NOT_FOUND
INCORRECT_FLAG_SET_FOR_ESTIMATED_DELIVERY_TIME
ESTIMATED_DELIVERY_TIME_NOT_AVAILABLE
INVALID_INPUT_PICKUP_POINT_FOUND
OUTSIDE_STANDARD_COVERAGE_AREA_FOR_PRODUCT
ESTIMATED_ARRIVAL_TIME_NOT_FOUND
ESTIMATED_ARRIVAL_TIME_NOT_AVAILABLE
ADDRESS_NOT_MATCHED
SVALBARD_POSSIBLE_DELAY
SPECIAL_CARGO_LIMITS_EXCEEDED
EXPECTED_DELIVERY_NOT_AVAILABLE_WITHOUT_ADDRESS
EXPECTED_DELIVERY_NOT_AVAILABLE_UNKNOWN_ADDRESS
NO_ENVIRONMENTAL_DATA
PARCEL_LOCKER_UNIT_ID_MANDATORY_FOR_ESTIMATED_DELIVERY_TIME
LEADTIME_NOT_FOUND
REQUIRES_WEIGHT_FOR_PRICE_CALCULATION
description
Human-readable description of the warning
string
uniqueId
Request unique id
string
object
List of consignments
array wrapped
List of consignments
object
consignmentId
The consignment id
string attribute

The requested services results.

ShippingGuide will never remove services from the request if unable to calculate any of the requested data. It will either return the requested data or a service level error code along with a description.

array wrapped

The requested services results.

ShippingGuide will never remove services from the request if unable to calculate any of the requested data. It will either return the requested data or a service level error code along with a description.

object
CustomerNumber
The mybring API customer number
string
EDI information required to make EDI bookings
object
Cargo service data required to make EDI booking
object
CargoProduct
Cargo product
string
CargoTransportType
Cargo transport type
string
DispatchAgentNumber
Required
Dispatch agent number
string
Courier service data required to make EDI booking
object
Department
Required
Department
string
NumberOfKilometers
Number of kilometers
string
OperationsID
Required
Operations id
string
OrderStartTime
Order start time
string
Quickpack service data required to make EDI booking
object
OrderStartTime
Order start time
string
Quickpack service data required to make EDI booking while using UPS as a transport service provider
object
BringStreamIndicator
Required
Bring stream indicator
string
Leg1CustomerNumber
Required
Transport leg 1 customer number
string
Leg1TransportServiceProvider
Required
Transport leg 1 service provider
string
StateProvinceCounty
Required
State/Province/County
string
UpsAccountNumber
Required
UPS account number
string
UpsBillingOption
Required
UPS billing option
string
UpsClassOfService
Required
UPS class of service
string
UpsDocumentationIndicator1
Required
UPS documentation indicator 1
string
UpsDocumentationIndicator2
Required
UPS documentation indicator 2
string
UpsRoutingCode
Required
UPS routing code
string
UpsRoutingCodeVersion
Required
UPS routing code version
string
UpsServiceIcon
Required
UPS service icon
string
UpsServiceIndicator
Required
UPS service indicator
string
UpsServiceTitle
Required
UPS service title
string
UpsSignatureRequiredString
Required
UPS signature required
string
Environmental profile of transport legs. Returned when withEnvironmentalData is requested and requested service is supported.
array wrapped
Environmental profile of transport leg
object
Description
Human readable description
string
Fossil free vehicle details
object
Bio
Share of bio-diesel vehicles used on this transportation leg
number <double>
Electric
Share of electric vehicles used on this transportation leg
number <double>
FossilFree
If true, shipment is transported by fossil free vehicles on this leg
boolean
NordicSwanEcoLabel
If true, shipment that is transported is nordic swan eco labeled
boolean
TransportLegType
Required
Transport leg
string
Enum
LAST_MILE
LINE_HAUL
FIRST_MILE
Errors related to requested service, if any
array wrapped
Service related error
object
code
Required
Error code
string
Enum
NOT_FOUND
FORBIDDEN
CONFLICT
UNAUTHORIZED
INVALID_ARGUMENT
INVALID_MEASUREMENTS
INTERNAL_ERROR
description
Required
Human-readable description of the error that occurred
string
Estimated delivery times at provided pickup point ids. Only relevant when withEstimatedDeliveryTime flag is set for services delivered to pickup point.
array wrapped
Estimated delivery time at pickup point
object
DeliveryEndTime
Delivery time window end time at the specified pickup point
string
DeliveryStartTime
Delivery time window start time at the specified pickup point
string
FormattedExpectedDeliveryDate
Formatted expected delivery date
string
PickupPointId
Required
Pickup point id. Either provided in the request or fetched as default pickup point for recipient postal code
string
PickupPointName
Pickup point name
string
ShippingDate
Formatted shipping date
string
WorkingDays
Number of working days until delivery
string
Expected delivery details for the shipment
object
Alternative delivery dates
array wrapped
Alternative delivery date
object
Required
Delivery date
object
Day
Required
string
Hour
string
Minute
string
Month
Required
string
array wrapped
object
Required
object
Hour
Required
string
Minute
Required
string
Required
object
Hour
Required
string
Minute
Required
string
Year
Required
string
FormattedExpectedDeliveryDate
Formatted expected delivery date
string <dd.MM.yyyy>
Required
Delivery date
object
Day
Required
string
Hour
string
Minute
string
Month
Required
string
array wrapped
object
Required
object
Hour
Required
string
Minute
Required
string
Required
object
Hour
Required
string
Minute
Required
string
Year
Required
string
WorkingDays
Required
Number of working days until delivery
string
BookingCutoffTime
The deadline for booking a shipment to the given destination. Only relevant for OIL_EXPRESS.
string <HH:mm>
Delivery date
object
Day
Required
string
Hour
string
Minute
string
Month
Required
string
array wrapped
object
Required
object
Hour
Required
string
Minute
Required
string
Required
object
Hour
Required
string
Minute
Required
string
Year
Required
string
Delivery date
object
Day
Required
string
Hour
string
Minute
string
Month
Required
string
array wrapped
object
Required
object
Hour
Required
string
Minute
Required
string
Required
object
Hour
Required
string
Minute
Required
string
Year
Required
string
FormattedEarliestPickupDate
Formatted earliest pickup date
string <dd.MM.yyyy>
FormattedExpectedDeliveryDate
Expected delivery date/time formatted as dd.MM.YYYY HH:mm
string <dd.MM.YYYY HH:mm>
Same day delivery details. Only relevant for services supporting delivery today or tomorrow like 5600 + 2012 VAS
object
Required
Delivery date
object
Day
Required
string
Hour
string
Minute
string
Month
Required
string
array wrapped
object
Required
object
Hour
Required
string
Minute
Required
string
Required
object
Hour
Required
string
Minute
Required
string
Year
Required
string
FormattedDeliveryDate
Required
Formatted delivery date
string <dd.MM.yyyy>
Route information
object
RouteId
Required
Route id
string
RouteName
Required
Route name
string
UserMessage
If there is known inaccuracy in the calculated lead time, this message will contain a human readable text explaining the deviation
string
WorkingDays
Required
The expected number of working days to deliver the shipment
string
GreenDelivery
Indicates whether the shipment is being delivered with fossil free transportation or not. Only relevant for HD-services
boolean
Detailed description of the requested service. All texts are in the requested language whenever translations are available.
object
ClosestPickupPoint
Default pickup point for the requested toPostalCode. Only relevant for pickup point services SERVICEPAKKE, 5800 and 3067
string
DeliveryType
Required
Service delivery type
string
DescriptionText
Required
Service description
string
DisplayName
Required
Service display name
string
EnvironmentalLogoUrl
URL to logo for labelling service as environmental friendly
string
EnvironmentalTagUrl
URL to tag for labelling services as environmental friendly
string
HelpText
Required
Service help text
string
Logo
Logo type to be used with this service
string
Enum
POSTEN
BRING
LogoUrl
URL to a suitable logo in svg format
string
MainDisplayCategory
Required
Main display category
string
MaxWeightInKgs
Required
Service max weight in kgs
string
ProductName
Required
Service name
string
ProductURL
Required
URL to service description page
string
ShortName
Required
Service short name
string
SubDisplayCategory
Required
Sub display category
string
Trackable
Is this service trackable
boolean
Id
Required
The service id
string
Requested service and additional services prices
object
Net (agreeemnt) price for shipping the service. Will only be calculated if a valid customer number has been supplied for the service
object
Additional service prices
array wrapped
Additional service prices
object
AdditionalServiceCodeFromProductionSystem
Required
string
AdditionalServiceDescription
Required
string
AdditionalServiceId
Required
string
Required
Price with additional services
object
AmountWithVAT
Required
string
AmountWithoutVAT
Required
string
VAT
Required
string
Agreement price (contract/agreement) attributes used for net prices used for producing EDI. Never set for list prices.
object
AgreementNumber
string
Cargo agreement price attributes
array wrapped
Cargo agreement price attributes
object
AgreementName
Required
Agreement name
string
AgreementNumber
Required
Agreement number
string
Price
Required
Agreement price
string
SubAgreementName
Required
Sub agreement name
string
SubAgreementNumber
Required
Sub agreement number
string
currencyCode
Currency code for all prices
string attribute
netPriceFailed
Only used for net prices in the scenario where net price calculation fails. If true, returned net price will be equal to list price, or a partially discounted price (i.e. a value between the list price and the correct net price)
boolean attribute
Required
Price with additional services
object
AmountWithVAT
Required
string
AmountWithoutVAT
Required
string
VAT
Required
string
Required
Price with additional services
object
AmountWithVAT
Required
string
AmountWithoutVAT
Required
string
VAT
Required
string
Net (agreeemnt) price for shipping the service. Will only be calculated if a valid customer number has been supplied for the service
object
Additional service prices
array wrapped
Additional service prices
object
AdditionalServiceCodeFromProductionSystem
Required
string
AdditionalServiceDescription
Required
string
AdditionalServiceId
Required
string
Required
Price with additional services
object
AmountWithVAT
Required
string
AmountWithoutVAT
Required
string
VAT
Required
string
Agreement price (contract/agreement) attributes used for net prices used for producing EDI. Never set for list prices.
object
AgreementNumber
string
Cargo agreement price attributes
array wrapped
Cargo agreement price attributes
object
AgreementName
Required
Agreement name
string
AgreementNumber
Required
Agreement number
string
Price
Required
Agreement price
string
SubAgreementName
Required
Sub agreement name
string
SubAgreementNumber
Required
Sub agreement number
string
currencyCode
Currency code for all prices
string attribute
netPriceFailed
Only used for net prices in the scenario where net price calculation fails. If true, returned net price will be equal to list price, or a partially discounted price (i.e. a value between the list price and the correct net price)
boolean attribute
Required
Price with additional services
object
AmountWithVAT
Required
string
AmountWithoutVAT
Required
string
VAT
Required
string
Required
Price with additional services
object
AmountWithVAT
Required
string
AmountWithoutVAT
Required
string
VAT
Required
string
Price zone details
object
TotalZoneCount
The total number of price zones used during price calculation
integer <int32>
ProductionCode
Backend system production code. This code is required when producing valid EDI messages during ordering.
string
ShippingWeight
The calculated volumetric weight (chargeable weight)
number <double>
SortingCode
Sorting code. Only relevant for home delivery services with Norway as destination.
string
SortingDirection
Sorting direction. Only relevant for home delivery services with Norway as destination.
string
Warnings related to the requested service, if any. Warnings could explain why some parts of the requested data is missing
array wrapped
Warnings related to the requested service, if any. Warnings could explain why some parts of the requested data is missing
object
code
Required
Warning code
string
Enum
NO_EXPECTED_DELIVERY
NO_PRICE_INFORMATION
ADDITIONAL_SERVICE_NOT_APPLICABLE
ESTIMATED_DELIVERY_TIME_NOT_FOUND
INCORRECT_FLAG_SET_FOR_ESTIMATED_DELIVERY_TIME
ESTIMATED_DELIVERY_TIME_NOT_AVAILABLE
INVALID_INPUT_PICKUP_POINT_FOUND
OUTSIDE_STANDARD_COVERAGE_AREA_FOR_PRODUCT
ESTIMATED_ARRIVAL_TIME_NOT_FOUND
ESTIMATED_ARRIVAL_TIME_NOT_AVAILABLE
ADDRESS_NOT_MATCHED
SVALBARD_POSSIBLE_DELAY
SPECIAL_CARGO_LIMITS_EXCEEDED
EXPECTED_DELIVERY_NOT_AVAILABLE_WITHOUT_ADDRESS
EXPECTED_DELIVERY_NOT_AVAILABLE_UNKNOWN_ADDRESS
NO_ENVIRONMENTAL_DATA
PARCEL_LOCKER_UNIT_ID_MANDATORY_FOR_ESTIMATED_DELIVERY_TIME
LEADTIME_NOT_FOUND
REQUIRES_WEIGHT_FOR_PRICE_CALCULATION
description
Required
Human-readable description of the warning
string
uniqueId
Request unique id
string attribute
400 Bad Request

Schema

Required
array of objects
code
string
Enum
NOT_FOUND
FORBIDDEN
CONFLICT
UNAUTHORIZED
INVALID_ARGUMENT
INVALID_MEASUREMENTS
INTERNAL_ERROR
field
string
message
string
object
Required
array wrapped
object
Code
Required
string
Enum
NOT_FOUND
FORBIDDEN
CONFLICT
UNAUTHORIZED
INVALID_ARGUMENT
INVALID_MEASUREMENTS
INTERNAL_ERROR
Field
Required
string
Message
Required
string
429 Too Many Requests

Schema

Media type: text/plain

string
500 Internal Server Error

Schema

Required
array of objects
code
string
Enum
NOT_FOUND
FORBIDDEN
CONFLICT
UNAUTHORIZED
INVALID_ARGUMENT
INVALID_MEASUREMENTS
INTERNAL_ERROR
field
string
message
string
object
Required
array wrapped
object
Code
Required
string
Enum
NOT_FOUND
FORBIDDEN
CONFLICT
UNAUTHORIZED
INVALID_ARGUMENT
INVALID_MEASUREMENTS
INTERNAL_ERROR
Field
Required
string
Message
Required
string

Request examples

{
  "consignments": [
    {
      "fromCountryCode": "NO",
      "fromPostalCode": "1555",
      "id": "1",
      "packages": [
        {
          "grossWeight": 250,
          "id": "1"
        }
      ],
      "products": [
        {
          "customerNumber": "123456789",
          "id": "5600"
        }
      ],
      "shippingDate": {
        "day": "15",
        "hour": "10",
        "minute": "36",
        "month": "11",
        "year": "2022"
      },
      "toCountryCode": "NO",
      "toPostalCode": "0173"
    }
  ],
  "edi": false,
  "language": "NO",
  "numberOfAlternativeDeliveryDates": 3,
  "postingAtPostoffice": false,
  "trace": false,
  "withExpectedDelivery": true,
  "withGuiInformation": true,
  "withPrice": true,
  "withUniqueAlternateDeliveryDates": true
}
<?xml version="1.0" encoding="UTF-8"?>
<ShippingGuideRequest>
  <Consignments>
    <Consignment id="1">
      <FromCountryCode>NO</FromCountryCode>
      <FromPostalCode>1555</FromPostalCode>
      <Packages>
        <Package id="1">
          <GrossWeight>250</GrossWeight>
        </Package>
      </Packages>
      <Products>
        <ProductIdType>
          <CustomerNumber>123456789</CustomerNumber>
          <Id>5600</Id>
        </ProductIdType>
      </Products>
      <ShippingDate>
        <Day>15</Day>
        <Hour>10</Hour>
        <Minute>36</Minute>
        <Month>11</Month>
        <Year>2022</Year>
      </ShippingDate>
      <ToCountryCode>NO</ToCountryCode>
      <ToPostalCode>0173</ToPostalCode>
    </Consignment>
  </Consignments>
  <Language>NO</Language>
  <NumberOfAlternativeDeliveryDates>3</NumberOfAlternativeDeliveryDates>
  <WithExpectedDelivery>true</WithExpectedDelivery>
  <WithGuiInformation>true</WithGuiInformation>
  <WithPrice>true</WithPrice>
  <WithUniqueAlternateDeliveryDates>true</WithUniqueAlternateDeliveryDates>
</ShippingGuideRequest>

Response examples

{
  "consignments": [
    {
      "consignmentId": "1",
      "products": [
        {
          "expectedDelivery": {
            "alternativeDeliveryDates": [
              {
                "expectedDeliveryDate": {
                  "day": "18",
                  "month": "11",
                  "timeSlots": [
                    {
                      "endTime": {
                        "hour": "21",
                        "minute": "0"
                      },
                      "startTime": {
                        "hour": "17",
                        "minute": "0"
                      }
                    }
                  ],
                  "year": "2022"
                },
                "formattedExpectedDeliveryDate": "18.11.2022",
                "shippingDate": {
                  "day": "16",
                  "month": "11",
                  "year": "2022"
                },
                "workingDays": "1"
              },
              {
                "expectedDeliveryDate": {
                  "day": "21",
                  "month": "11",
                  "timeSlots": [
                    {
                      "endTime": {
                        "hour": "21",
                        "minute": "0"
                      },
                      "startTime": {
                        "hour": "17",
                        "minute": "0"
                      }
                    }
                  ],
                  "year": "2022"
                },
                "formattedExpectedDeliveryDate": "21.11.2022",
                "shippingDate": {
                  "day": "16",
                  "month": "11",
                  "year": "2022"
                },
                "workingDays": "1"
              },
              {
                "expectedDeliveryDate": {
                  "day": "22",
                  "month": "11",
                  "timeSlots": [
                    {
                      "endTime": {
                        "hour": "21",
                        "minute": "0"
                      },
                      "startTime": {
                        "hour": "17",
                        "minute": "0"
                      }
                    }
                  ],
                  "year": "2022"
                },
                "formattedExpectedDeliveryDate": "22.11.2022",
                "shippingDate": {
                  "day": "16",
                  "month": "11",
                  "year": "2022"
                },
                "workingDays": "1"
              }
            ],
            "earliestPickupDate": {
              "day": "16",
              "hour": "13",
              "minute": "23",
              "month": "11",
              "year": "2022"
            },
            "expectedDeliveryDate": {
              "day": "16",
              "month": "11",
              "timeSlots": [
                {
                  "endTime": {
                    "hour": "21",
                    "minute": "0"
                  },
                  "startTime": {
                    "hour": "17",
                    "minute": "0"
                  }
                }
              ],
              "year": "2022"
            },
            "formattedEarliestPickupDate": "16.11.2022 13:23",
            "formattedExpectedDeliveryDate": "18.11.2022",
            "userMessage": "",
            "workingDays": "1"
          },
          "id": "5600",
          "productionCode": "5600"
        }
      ]
    }
  ],
  "uniqueId": "66091c94-6565-4c42-9c49-34bab012236d"
}
comments powered by Disqus