Shipping Guide API

Decommissioned version 4, 5 and 6 of the Shipping Guide API. Customers should use Shipping Guide API 2.0 instead.

Introduction

The Shipping Guide (Fraktguiden) is a free service from Bring that provides

price information,
service area (Norwegian: dekningsområde), and
estimated delivery times.

With the Shipping Guide it is easy to offer different shipping alternatives to your end customers. Whether they want to

get delivery to the door (daytime or evening),
pick up the shipment at a post office, or
get the shipment delivered to the mailbox

The Shipping Guide returns the recommended way to present these shipping alternatives, as well as prices and delivery times.

Demo shipping alternatives.

The demo shows that the Shipping Guide returns service categories for each request, making a shipping alternatives-page easy to set up. The focus is on delivery methods to the end customer, not service names.

The Shipping Guide has several interfaces (SOAP and XML/JSON). Choose the option that fits your needs best (see table below). The SOAP interface is the core interface with complete functionality. There are some limitations in the XML/JSON API, such as the inability to mark a parcel as a specialized goods.

There is also a Offline SOAP service for retrieving data for offline use (get complete prices, service area and delivery times based on a fixed sender postal code).

Available services

The Shipping Guide API has a lot of various services and value added services. So many, in fact, that we decided to document them in a separate page.

See the whole list of services and value added services here.

General Guidelines

VAT

Shipping Guide specifies VAT related to senders country. It’s up to the client to decide if VAT is applicable to their situation of sale.

Value added services affecting price

Make sure you specify the correct value added services for a package when querying the Shipping Guide.

Especially the evarsling value added service for the Servicepakke service (recipient notification over SMS or E-Mail) will affect the base package price returned from the Shipping Guide, and should therefore be set according to what will be sent in the actual EDI message.

If evarsling is not specified in the request, Fraktguiden will from 2013-01-01 add a fee for paper based recipient notification to the base package price for Servicepakke. As of 2013-01-01 the fee is NOK 4,-

Error Handling Guidelines

When using the Shipping Guide, it is important to handle errors gracefully. Your web shop’s users should still be able to order, even if the Shipping Guide returns an error or a timeout occurs.

No services applicable

If there are no services applicable for the requested shipment, an empty resultset will be returned. This means that for the passed-in service list, no services can be used for the shipment. Either the shipment is too large or is outside of the coverage area of all the requested services. Your code should handle this case, i.e. an empty service list for the shipment.

One suggestion is to include more services in each request, e.g. a Cargo-service to handle large shipments. You should know how to send Cargo services before including it though.

General errors

When using the Shipping Guide, errors or service unavailability can occur, although we do our utmost to prevent any downtime. Thus it is important to use timeouts and other error handling techniques when making requests to the service.

How you handle errors depends on the nature of your application, but one strategy for handling such situations is by providing a failover if the shipping guide responds with an error or does not respond at all (timeout).

For instance your application can respond to an error by using prefetched offline data to calculate prices and delivery time estimates. Another alternative would be to use a a fixed standard price whenever an error occurs.

Error codes for rejected requests

Code	Message in English	Message in Norwegian
FG_INPUT_001	Shipping date must be set	Innleveringsdato må være satt
FG_INPUT_002	Error with Postal code	Feil i postnummer
FG_INPUT_003	Missing UserInformation element in request	Mangler UserInformation element i request.
FG_INPUT_004	At least one product id must be set	Minst et produkt må være valgt
FG_INPUT_005	Wrong date format	Feil i datoformat
FG_INPUT_006	Error with volume	Feil med volum
FG_INPUT_008	Missing Package element	Mangler Package element
FG_INPUT_010	Error number of alternative deliverydates	Feil antall alternative leveringsdager
FG_INPUT_011	Wrong weight unit code	Feil vektkode
FG_INPUT_012	Invalid weight format	Feil vekt format
FG_INPUT_013	Invalid volume format	Feil volum format
FG_INPUT_014	Invalid volume unit code	Feil volumkode
FG_INPUT_016	Invalid input dimensions	Feil med dimensjoner
FG_INPUT_017	Invalid input dimensions unit code	Feil dimensjonskode
FG_INPUT_018	Too many packages	For mange pakker
FG_INPUT_019	Product id missing	Produkt id mangler
FG_INPUT_020	Invalid offline from post number	Feil offline fra postnummer
FG_INPUT_021	Non existing postalcode	Postnummer eksisterer ikke
FG_INPUT_022	Missing weight or volume	Mangler vekt eller volum
FG_INPUT_023	Unexpected parameter	Ikke gyldig parameter
FG_INPUT_024	Invalid input price adjustment	Feil input til prisjustering
FG_INPUT_025	Unknown public id	Feil public id
FG_INPUT_027	Invalid country code	Feil landkode
FG_INPUT_029	Wrong time format	Feil tidsformat
FG_INPUT_030	Invalid request version	Ugyldig request versjon
FG_INPUT_031	Request version missing	Request versjon mangler
FG_INPUT_032	Mismatch in value in package and consignment.	Mismatch i verdi i pakke i forhold til sending.
FG_INPUT_033	A consignment element must be specified when requesting a consignment-oriented service.	Det må spesifiseres et consignment-element når det bes om et sendingsorientert produkt.
FG_INPUT_034	Error with City	Feil i city
FG_INPUT_035	Shipping date must be current date or in the future when net prices are requested.	Avtalepriser støtter ikke shipping date tilbake i tid.
FG_INPUT_036	Schema version 8 and newer does no longer support user code. Use Client URL instead. See XSD Schema documentation.	Schema versjon 8 og nyere støtter ikke lenger user code. Bruk heller Client URL. Sjekk XSD Schema dokumentasjon.
FG_INPUT_037	Schema version 8 and newer requires Client URL element set. See XSD Schema documentation.	Schema versjon 8 og nyere krever Client URL element set. Sjekk XSD Schema dokumentasjon.
FG_INPUT_038	Schema version 8 and newer requires that the api.bring.com/shippingguide endpoint is used. Check out developer.bring.com	Schema versjon 8 og nyere krever at api.bring.com/shippingguide endpoint benyttes. Se developer.bring.com.
FG_INPUT_039	Endpoint at api.bring.com/shippingguide requires that schema version 8 or newer is used. Check out developer.bring.com	Endpoint på api.bring.com/shippingguide krever at schema version 8 eller nyere benyttes. Se developer.bring.com.
FG_INPUT_040	Invalid UNNumber format. UNNumber must be a four digit string. Ex: 0030	Feil UNNumber format. UNNumber skal være en fire sifret streng. Eks: 0030
FG_INPUT_041	Oil express product requires a customer number set on the product element, because only contract prices are available.	Oljeekspressproduktet krever et kundenummer. Kun avtalepris tilgjengelig.
FG_INPUT_042	Could not parse the input string to Betaler.	Kunne ikke analysere strengen til påvirker betaler.
FG_INPUT_043	Invalid combination of value added services.	Ugyldig kombinasjon av tilleggstjenester.
FG_INPUT_044	Missing Consignment Request element.	Mangler Consignment Request element.
FG_PRODUCT_001	Product unknown	Produkt ukjent
FG_PRODUCT_002	Product not available as offline data.	Produkt ikke tilgjengelig i offline data-format.
FG_PRODUCT_003	Outside of coverage area for product.	Utenfor dekningsområde for produkt.
FG_UNKNOWN_001	Unknown internal error	Ukjent intern feil
FG_USER_002	Wrong usercode	Feil identifiakasjonsstreng
FG_USER_007	Customer number specified, but user is not logged in. Please set the mybring authentication headers.	Kundenummer angitt, men bruker er ikke innlogget. Vennligst sett mybring autentiseringsheadere.
FG_USER_008	Logged-in user does not have access to specified customer	Pålogget bruker har ikke tilgang spesifisert kunde
FG_USER_009	Customer number is not applicable for specified produkt	Kundenummer er ikke gyldig for spesifisert produktkode
FG_USER_010	Customer not found for super user.	Kunde ikke funnet for superbruker
FG_USER_011	Customer does not have right access role for service	Kunde har ikke riktig tilgangs rolle for tjenesten
FG_EXTERNAL_SERVICE_NO_PRICE	An external system failed to return the cost for the actual shipping. Please check your input data.	Et eksternt system returnerte ikke pris på selve frakten. Vennligst sjekk input data.

Offline data

Offline data lets you download a failover version of the data from the Shipping Guide.

By using the Offline Data Web Service (see WSDL) or Offline Data form you can download price lists, transport times and value added services designed for offline usage. Offline data is suitable as a failover solution if the Shipping Guide does not respond or responds with an error message, or if there are extreme demands on performance.

Important! With offline data, you have to deal with all the rules of special goods, shipping calculated weight (volume weight), and more. These rules are located on the respective service pages on bring.com. Remember to update the database at price changes!

The service is available free of charge, provided acceptance of the terms of use. Note that only registered users will receive notifications of changes in service!

For those who use the offline data, we recommend to get the updates automatically via Offline Data Web Service.

Useful XPaths when processing offline data

Get Price Zone (returns an empty answer if toPostalCode is outside the coverage area for the chosen service):

//Product[@productId='SERVICEPAKKE']//PriceZone[@toPostalCode='2000']/text()

Get Price based on Price Zone “2”:

//Product[@productId="SERVICEPAKKE"]//Price[@priceZone="2" and @weight="4000"]/text()

Get transport time (older versions):

//Product[@productId='SERVICEPAKKE']//WorkingDays[@toPostalCode="2000"]/text()

Get transport time (version 11):

//Product[@productId='SERVICEPAKKE']//ExpectedDeliveryTime[@toPostalCode="2000"]/WorkingDays/text()

Additional information

If you are a Mybring user, you can authenticate requests to the Shipping Guide. Authenticated requests have the following benefits:

Agreement prices
Prices for value added services
Lead time
Coverage

Agreement prices are supported for all services except for Mail, Express and Courier Long Distance services. Fixing this is on our todo list, though.

Overview of endpoints

Base URL

https://api.bring.com/shippingguide

Method	Endpoint	Usage
GET	/products/price{mediaTypeExtension}	Get shipment prices
GET	/products/expectedDelivery{mediaTypeExtension}	Get estimated delivery time
GET	/products/all{mediaTypeExtension}	Get shipment prices, estimated delivery and more
GET	/api/ws	SOAP

Get shipment prices

URL

                          GET
                          https://api.bring.com/shippingguide/products/price.json
https://api.bring.com/shippingguide/products/price.xml

Request parameters

Query param	Type	Description
`NonStackable`	`boolean`	Required Default false. Set to true if you know that pallet would be non-stackable. Example: `true`
`additional`	`string`	Required Additional services. Request value added services for the package. Specified by adding one or more `additional` parameters to the request, e.g. &additional=postoppkrav&additional=evarsling. See the value added services list. The Shipping Guide will match the additional service codes to the requested services and ignore service / value added service codes that are not applicable. Example: `evarsling`
`clientUrl`	`string`	Required Client URL. To use the Shipping Guide you must specify a client url parameter. The client url should be set to the url of the web shop or application the end user is ordering from. The client url can be sent as a url parameter, clientUrl, or as a header, `X-Bring-Client-URL`. Example: `https://www.example.com/amazing-clothes/`
`customerNumber`	`string`	Required Customer number. This parameter lets you specify which customer number to use to get additional information about the specified service(s). This parameter requires user authentication. If you are authenticated but omit this parameter, shipping guide will try to select an applicable customer number for you. If there is only one applicable customer number, it will automatically be selected, but if there are multiple matches you have to specify which to use by using this parameter. Example: `CARGO-123456`
`date`	`string`	Required Shipping date. Specifies which date the parcel will be delivered to Bring (within the time limit), and is used to calculate the delivery date. Date is specified in ISO format, `YYYY-MM-DD`. Example: `2015-11-18`
`edi`	`boolean`	Required EDI setting. Flag that tells if the parcel will be registred using EDI when it is shipped. Note that this flag may affect price and which services are available. Possible values: `true` `false` Default value: `true`
`from`	`string`	Required From postal code. Example: `7600`
`height`	`integer`	Required Package height in centimeters. Example: `30`
`language`	`string`	Required Language. Which language the descriptive service texts should have. Supported languages are Swedish (se), Danish (da) and Norwegian (no). If no language is set, or text is not available in the requested language, Norwegian text is returned. Default value: `no` Example: `se`
`length`	`integer`	Required Package length in centimeters. Example: `40`
`loadMeters`	`double`	Required Package loading meters in meters. Example: `1.22`
`numberOfPallets`	`integer`	Required Number of pallets. Example: `10`
`pid`	`string`	Required Public ID. The last part (after the last dash) of your identification string (logged-in information for user of Shipping Guide). This makes the Shipping Guide know who performs the query, so we may contact the correct shipping guide user for potential follow ups.
`postingAtPostOffice`	`boolean`	Required Flag that tells whether the parcel is delivered at a post office when it is shipped. A surcharge will be applied for the following services: SERVICEPAKKE BPAKKE_DOR-DOR (Bedriftspakke) Possible values: `true` `false`
`priceAdjustments`	`string`	Required Adjusts the price (w/o VAT) returned. The format of it is `[<product code>_][p(lus)\|m(inus)]factor[p(ercentage)]` Pattern: `^((\w_)?(p\|m\|)\d(\.\d\|)\|(\w_)?(p\|m)\d(\.\d\|)p)$` Example: `m20p`
`product`	`string`	Required Products. This parameter lets you specify which services you want to return information about. If you omit this parameter, you get the default service list (not recommended for serviceion usage). Service is specified by adding one or more service parameters, e.g. product=servicepakke&product=bpakke_dor-dor. Example: `bpakke_dor-dor`
`time`	`string`	Required Shipping time. Shipping time may be specified. Note that Bring’s courier services are the only one affected by this parameter. Time is specified in ISO format, `HH:mm`. Example: `12:30`
`to`	`string`	Required To postal code. Example: `1407`
`volumeSpecial`	`boolean`	Required Special volume. Flag to indicate if the package has a shape that may require ‘special handling fee’. product=servicepakke&product=bpakke_dor-dor.
`weightInGrams`	`integer`	Required Weight of package in grams. Example: `1500`
`width`	`integer`	Required Package width in centimeters. Example: `40`

Responses

HTTP status code 200

In this example, we’re querying for prices for Pickup Parcel and Pickup Parcel Business for a 2,5kg package from Sweden to Denmark.

Request: …&fromCountry=SE&from=11640&toCountry=DK&to=1440&product=pickup_parcel&product=business_parcel

Media type: application/json

Example: Shipment prices

{
   "@packageId": "0",
   "Product": [{
      "ProductId": "PICKUP_PARCEL",
      "ProductCodeInProductionSystem": "0340",
      "Price": {
         "@currencyIdentificationCode": "SEK",
         "PackagePriceWithoutAdditionalServices": {
            "AmountWithoutVAT": "293.90",
            "VAT": "73.47",
            "AmountWithVAT": "367.37"
         },
         "PackagePriceWithAdditionalServices": {
            "AmountWithoutVAT": "293.90",
            "VAT": "73.47",
            "AmountWithVAT": "367.37"
         }
      }
   }, {
      "ProductId": "BUSINESS_PARCEL",
      "ProductCodeInProductionSystem": "0330",
      "Price": {
         "@currencyIdentificationCode": "SEK",
         "PackagePriceWithoutAdditionalServices": {
            "AmountWithoutVAT": "335.00",
            "VAT": "83.75",
            "AmountWithVAT": "418.75"
         },
         "PackagePriceWithAdditionalServices": {
            "AmountWithoutVAT": "335.00",
            "VAT": "83.75",
            "AmountWithVAT": "418.75"
         }
      }
   }],
   "TraceMessages": {
      "Message": ["Using VAT rate of origin country and leaving it up to you as a client to decide whether or not VAT is applicable in the specific sales situation.", "Price for PICKUP_PARCEL is without fuel surcharge. This fee must be added manually by the client.", "Price for BUSINESS_PARCEL is without fuel surcharge. This fee must be added manually by the client."]
   }
}

Media type: application/xml

Example: Shipment prices


<?xml version="1.0" encoding="UTF-8"?>
<Package packageId="0">
  <!--See service terms and conditions at https://developer.bring.com/-->
  <Product>
    <ProductId>PICKUP_PARCEL</ProductId>
    <ProductCodeInProductionSystem>0340</ProductCodeInProductionSystem>
    <Price currencyIdentificationCode="SEK">
      <PackagePriceWithoutAdditionalServices>
        <AmountWithoutVAT>293.90</AmountWithoutVAT>
        <VAT>73.47</VAT>
        <AmountWithVAT>367.37</AmountWithVAT>
      </PackagePriceWithoutAdditionalServices>
      <PackagePriceWithAdditionalServices>
        <AmountWithoutVAT>293.90</AmountWithoutVAT>
        <VAT>73.47</VAT>
        <AmountWithVAT>367.37</AmountWithVAT>
      </PackagePriceWithAdditionalServices>
    </Price>
  </Product>
  <Product>
    <ProductId>BUSINESS_PARCEL</ProductId>
    <ProductCodeInProductionSystem>0330</ProductCodeInProductionSystem>
    <Price currencyIdentificationCode="SEK">
      <PackagePriceWithoutAdditionalServices>
        <AmountWithoutVAT>335.00</AmountWithoutVAT>
        <VAT>83.75</VAT>
        <AmountWithVAT>418.75</AmountWithVAT>
      </PackagePriceWithoutAdditionalServices>
      <PackagePriceWithAdditionalServices>
        <AmountWithoutVAT>335.00</AmountWithoutVAT>
        <VAT>83.75</VAT>
        <AmountWithVAT>418.75</AmountWithVAT>
      </PackagePriceWithAdditionalServices>
    </Price>
  </Product>
  <TraceMessages>
    <Message>Using VAT rate of origin country and leaving it up to you as a client to decide whether or not VAT is applicable in the specific sales situation.</Message>
    <Message>Price for PICKUP_PARCEL is without fuel surcharge. This fee must be added manually by the client.</Message>
    <Message>Price for BUSINESS_PARCEL is without fuel surcharge. This fee must be added manually by the client.</Message>
  </TraceMessages>
</Package>

Get estimated delivery time

URL

                          GET
                          https://api.bring.com/shippingguide/products/expectedDelivery.json
https://api.bring.com/shippingguide/products/expectedDelivery.xml

Request parameters

Query param	Type	Description
`additional`	`string`	Required Additional services. Request value added services for the package. Specified by adding one or more `additional` parameters to the request, e.g. &additional=postoppkrav&additional=evarsling. See the value added services list. The Shipping Guide will match the additional service codes to the requested services and ignore service / additional service codes that are not applicable. Example: `evarsling`
`clientUrl`	`string`	Required Client URL. To use the Shipping Guide you must specify a client url parameter. The client url should be set to the url of the web shop or application the end user is ordering from. The client url can be sent as a url parameter, clientUrl, or as a header, `X-Bring-Client-URL`. Example: `https://www.example.com/amazing-clothes/`
`date`	`date`	Required Shipping date. Specifies which date the parcel will be delivered to Bring (within the time limit), and is used to calculate the delivery date. Date is specified in ISO format, `YYYY-MM-DD`. Example: `2015-11-18`
`edi`	`boolean`	Required EDI setting. Flag that tells if the parcel will be registred using EDI when it is shipped. Note that this flag may affect price and which services are available. Default value: `true`
`from`	`string`	Required From postal code. Example: `7600`
`height`	`integer`	Required Package height in centimeters. Example: `30`
`language`	`string`	Required Language. Which language the descriptive service texts should have. Supported languages are English (en), Swedish (se), Finnish (fi), Danish (da) and Norwegian (no). If no language is set, or text is not available in the requested language, Norwegian text is returned. Default value: `no` Example: `en`
`length`	`integer`	Required Package length in centimeters. Example: `40`
`loadMeters`	`double`	Required Package loading meters in meters. Example: `1.22`
`numberOfPallets`	`integer`	Required Number of pallets. Example: `10`
`pid`	`string`	Required Public ID. The last part (after the last dash) of your identification string (logged-in information for user of Shipping Guide). This makes the Shipping Guide know who performs the query, so we may contact the correct shipping guide user for potential follow ups.
`postingAtPostOffice`	`boolean`	Required Flag that tells whether the parcel is delivered at a post office when it is shipped. A surcharge will be applied for the following services: SERVICEPAKKE BPAKKE_DOR-DOR (Bedriftspakke)
`priceAdjustments`	`string`	Required Price adjustments. Adjusts the price (w/o VAT) returned. The format of it is `[<product code>_][p(lus)\|m(inus)]factor[p(ercentage)]` Pattern: `^((\w_)?(p\|m\|)\d(\.\d\|)\|(\w_)?(p\|m)\d(\.\d\|)p)$` Example: `m20p`
`product`	`string`	Required Products. This parameter lets you specify which services you want to return information about. If you omit this parameter, you get the default service list (not recommended for production usage). Service is specified by adding one or more service parameters, e.g. product=servicepakke&product=bpakke_dor-dor. Example: `bpakke_dor-dor`
`time`	`date`	Required Shipping time. Shipping time may be specified. Note that Bring’s courier services are the only one affected by this parameter. Time is specified in ISO format, `HH:mm`. Example: `12:30`
`to`	`string`	Required To postal code. Example: `1407`
`volumeSpecial`	`boolean`	Required Special volume. Flag to indicate if the package has a shape that may require ‘special handling fee’. product=servicepakke&product=bpakke_dor-dor.
`weightInGrams`	`integer`	Required Weight of package in grams. Example: `1500`
`width`	`integer`	Required Package width in centimeters. Example: `40`

Responses

HTTP status code 200

In this example, we’re querying for expected delivery time for various services for a package from Sweden to Denmark.

Request: …fromCountry=SE&from=11640&toCountry=DK&to=1440&product=PICKUP_PARCEL&product=PICKUP_PARCEL_BULK&product=SERVICEPAKKE&product=BPAKKE_DOR-DOR

Media type: application/json

Example: Success

{
  "@packageId": "0",
  "Product": [{
    "ProductId": "PICKUP_PARCEL_BULK",
    "ProductCodeInProductionSystem": "0342",
    "ExpectedDelivery": {
      "WorkingDays": null,
      "UserMessage": "Fremsendingstider er ikke tilgjengelig for dette produktet.",
      "FormattedExpectedDeliveryDate": null,
      "FormattedEarliestPickupDate": null
    }
  }, {
    "ProductId": "PICKUP_PARCEL",
    "ProductCodeInProductionSystem": "0340",
    "ExpectedDelivery": {
      "WorkingDays": "1-2",
      "UserMessage": null,
      "AlternativeDeliveryDates": null
    }
  }],
  "TraceMessages": {
    "Message": ["Product SERVICEPAKKE can not be sent from country SWEDEN to country DENMARK ", "Product BPAKKE_DOR-DOR can not be sent from country SWEDEN to country DENMARK "]
  }
}

Media type: application/xml

Example: Success


<?xml version="1.0" encoding="UTF-8"?>
<Package packageId="0">
  <!--See service terms and conditions at https://developer.bring.com/-->
  <Product>
    <ProductId>PICKUP_PARCEL_BULK</ProductId>
    <ProductCodeInProductionSystem>0342</ProductCodeInProductionSystem>
    <ExpectedDelivery>
      <WorkingDays/>
      <UserMessage>Fremsendingstider er ikke tilgjengelig for dette produktet.</UserMessage>
      <FormattedExpectedDeliveryDate/>
      <FormattedEarliestPickupDate/>
    </ExpectedDelivery>
  </Product>
  <Product>
    <ProductId>PICKUP_PARCEL</ProductId>
    <ProductCodeInProductionSystem>0340</ProductCodeInProductionSystem>
    <ExpectedDelivery>
      <WorkingDays>1-2</WorkingDays>
      <UserMessage/>
      <AlternativeDeliveryDates/>
    </ExpectedDelivery>
  </Product>
  <TraceMessages>
    <Message>Product SERVICEPAKKE can not be sent from country SWEDEN to country DENMARK</Message>
    <Message>Product BPAKKE_DOR-DOR can not be sent from country SWEDEN to country DENMARK</Message>
  </TraceMessages>
</Package>

Get shipment prices, estimated delivery and more

Use this endpoint to get price, expected delivery, service categories and additional information such as an indication of which alternative has the least environmental impact.

URL

                          GET
                          https://api.bring.com/shippingguide/products/all.json
https://api.bring.com/shippingguide/products/all.xml

Request parameters

Query param	Type	Description
`NonStackable`	`boolean`	Required Default false. Set to true if you know that pallet would be non-stackable. Example: `true`
`additional`	`string`	Required Additional services. Request value added services for the package. Specified by adding one or more `additional` parameters to the request, e.g. &additional=postoppkrav&additional=evarsling. See the value added services list. The Shipping Guide will match the additional service codes to the requested services and ignore service / additional service codes that are not applicable. Example: `evarsling`
`clientUrl`	`string`	Required Client URL. To use the Shipping Guide you must specify a client url parameter. The client url should be set to the url of the web shop or application the end user is ordering from. The client url can be sent as a url parameter, clientUrl, or as a header, `X-Bring-Client-URL`. Example: `https://www.example.com/amazing-clothes/`
`customerNumber`	`string`	Required Customer number. This parameter lets you specify which customer number to use to get additional information about the specified service(s). This parameter requires user authentication. If you are authenticated but omit this parameter, shipping guide will try to select an applicable customer number for you. If there is only one applicable customer number, it will automatically be selected, but if there are multiple matches you have to specify which to use by using this parameter. Example: `CARGO-123456`
`date`	`date`	Required Shipping date. Specifies which date the parcel will be delivered to Bring (within the time limit), and is used to calculate the delivery date. Date is specified in ISO format, `YYYY-MM-DD`. Example: `2015-11-18`
`edi`	`boolean`	Required EDI setting. Flag that tells if the parcel will be registred using EDI when it is shipped. Note that this flag may affect price and which services are available. Default value: `true`
`from`	`string`	Required From postal code. Example: `7600`
`height`	`integer`	Required Package height in centimeters. Example: `30`
`language`	`string`	Required Language. Which language the descriptive service texts should have. Supported languages are English (en), Swedish (se), Finnish (fi), Danish (da) and Norwegian (no). If no language is set, or text is not available in the requested language, Norwegian text is returned. Default value: `no` Example: `en`
`length`	`integer`	Required Package length in centimeters. Example: `40`
`loadMeters`	`double`	Required Package loading meters in meters. Example: `1.22`
`numberOfPallets`	`integer`	Required Number of pallets. Example: `10`
`pid`	`string`	Required Public ID. The last part (after the last dash) of your identification string (logged-in information for user of Shipping Guide). This makes the Shipping Guide know who performs the query, so we may contact the correct shipping guide user for potential follow ups.
`postingAtPostOffice`	`boolean`	Required Flag that tells whether the parcel is delivered at a post office when it is shipped. A surcharge will be applied for the following services: SERVICEPAKKE BPAKKE_DOR-DOR (Bedriftspakke)
`priceAdjustments`	`string`	Required Price adjustments. Adjusts the price (w/o VAT) returned. The format of it is `[<product code>_][p(lus)\|m(inus)]factor[p(ercentage)]` Pattern: `^((\w_)?(p\|m\|)\d(\.\d\|)\|(\w_)?(p\|m)\d(\.\d\|)p)$` Example: `m20p`
`product`	`string`	Required Products. This parameter lets you specify which services you want to return information about. If you omit this parameter, you get the default service list (not recommended for serviceion usage). Service is specified by adding one or more service parameters, e.g. product=servicepakke&product=bpakke_dor-dor. Example: `bpakke_dor-dor`
`time`	`date`	Required Shipping time. Shipping time may be specified. Note that Bring’s courier services are the only one affected by this parameter. Time is specified in ISO format, `HH:mm`. Example: `12:30`
`to`	`string`	Required To postal code. Example: `1407`
`volumeSpecial`	`boolean`	Required Special volume. Flag to indicate if the package has a shape that may require ‘special handling fee’. product=servicepakke&product=bpakke_dor-dor.
`weightInGrams`	`integer`	Required Weight of package in grams. Example: `1500`
`width`	`integer`	Required Package width in centimeters. Example: `40`

Responses

HTTP status code 200

For a given shipment from A to B, the core way to use the Shipping Guide is to query for all the services you know how to send (e.g. the services you have a customer agreement for). From that given set of services specified in the request, the Shipping Guide will return the services that are relevant for the shipment, based on service attributes (e.g. max package size and weight) and service area (Norwegian: dekningsområde), e.g. not all services are offered to all postal codes.

Example: You have a package of 2,5 kilos from postal codes 0484 to 5600 that you want to send. Your webshop knows how to send (e.g. has a customer agreement) for sending the following Bring services:

Servicepakke
Bedriftspakke
Bedriftspakke Ekspress - Over Natten
På Døren
Mail

The Shipping Guide request should then be made for all the services (explicitly set using multiple service parameters), and the Shipping Guide will tell you which services are applicable. E.g. Mail is not applicable since the package is greater than 2 kg, and postal code 5600 is outside the service area for “På Døren”.

Request: ../all.json?clientUrl=insertYourClientUrlHere&weightInGrams=2500&from=0484&to=5600&product=servicepakke&product=bpakke_dor-dor&product=ekspress09&product=pa_doren&product=mail

Media type: application/json

{
  "@packageId": "0",
  "Product":    [
    {
      "ProductId": "SERVICEPAKKE",
      "ProductCodeInProductionSystem": "1202",
      "GuiInformation":          {
        "SortOrder": "11",
        "MainDisplayCategory": "Pakke",
        "SubDisplayCategory": "Til private",
        "DisplayName": "Klimanøytral Servicepakke",
        "ProductName": "Klimanøytral Servicepakke",
        "DescriptionText": "Pakken kan spores og utleveres på ditt lokale hentested.",
        "HelpText": "Klimanøytral Servicepakke leveres til mottakers lokale hentested (postkontor eller Post i Butikk). Mottaker kan velge å hente sendingen på et annet hentested enn sitt lokale. Mottaker varsles om at sendingen er ankommet via SMS, e-post eller hentemelding i postkassen. Sendingen kan spores ved hjelp av sporingsnummeret.",
        "ShortName": "Klimanøytral Servicepakke",
        "ProductURL": "http://www.bring.no/sende/pakker/private-i-norge/hentes-pa-posten",
        "DeliveryType": "Hentested",
        "Tip": null,
        "MaxWeightInKgs": "35"
      },
      "Price":          {
        "@currencyIdentificationCode": "NOK",
        "PackagePriceWithoutAdditionalServices":             {
          "AmountWithoutVAT": "132.00",
          "VAT": "33.00",
          "AmountWithVAT": "165.00"
        },
        "PackagePriceWithAdditionalServices":             {
          "AmountWithoutVAT": "132.00",
          "VAT": "33.00",
          "AmountWithVAT": "165.00"
        }
      },
      "ExpectedDelivery":          {
        "WorkingDays": "2",
        "UserMessage": null,
        "AlternativeDeliveryDates": null
      }
    },
    {
      "ProductId": "BPAKKE_DOR-DOR",
      "ProductCodeInProductionSystem": "1000",
      "GuiInformation":          {
        "SortOrder": "42",
        "MainDisplayCategory": "Pakke",
        "SubDisplayCategory": "Til bedrift",
        "DisplayName": "Bedriftspakke",
        "ProductName": "Bedriftspakke",
        "DescriptionText": "Pakken kan spores og utleveres på døren mellom kl. 8-16.",
        "HelpText": "Bedriftspakke leveres på døren til bedrift mellom kl. 8 og 16. Dersom sendingen ikke kan leveres ved første forsøk, gjøres et nytt utleveringsforsøk neste virkedag. Dersom sendingen ikke kan leveres, blir den sendt til mottakers lokale hentested (postkontor eller Post i Butikk). Sendingen kan spores ved hjelp av sporingsnummeret.",
        "ShortName": "Bedriftspakke",
        "ProductURL": "http://www.bring.no/sende/pakker/bedrift-i-norge/pa-doren-til-bedrift",
        "DeliveryType": "Dør",
        "Tip": null,
        "MaxWeightInKgs": "35"
      },
      "Price":          {
        "@currencyIdentificationCode": "NOK",
        "PackagePriceWithoutAdditionalServices":             {
          "AmountWithoutVAT": "173.00",
          "VAT": "43.25",
          "AmountWithVAT": "216.25"
        },
        "PackagePriceWithAdditionalServices":             {
          "AmountWithoutVAT": "173.00",
          "VAT": "43.25",
          "AmountWithVAT": "216.25"
        }
      },
      "ExpectedDelivery":          {
        "WorkingDays": "1",
        "UserMessage": null,
        "AlternativeDeliveryDates": null
      }
    },
    {
      "ProductId": "EKSPRESS09",
      "ProductCodeInProductionSystem": "1002",
      "GuiInformation":          {
        "SortOrder": "44",
        "MainDisplayCategory": "Pakke",
        "SubDisplayCategory": "Til bedrift",
        "DisplayName": "Bedriftspakke ekspress over natten",
        "ProductName": "Bedriftspakke ekspress over natten",
        "DescriptionText": "Pakken kan spores og utleveres på døren påfølgende virkedag innen kl. 9 (til mindre steder innen kl. 16).",
        "HelpText": "Bedriftspakke ekspress over natten leveres på døren til bedrift påfølgende virkedag innen kl. 9 (til mindre steder innen kl. 16). Dersom sendingen ikke kan leveres, blir den sendt til mottakers lokale hentested (postkontor eller Post i Butikk). Sendingen kan spores ved hjelp av sporingsnummeret.",
        "ShortName": "Bedriftspakke ekspress over natten",
        "ProductURL": "http://www.bring.no/sende/pakker/bedrift-i-norge/hurtig-til-bedrift",
        "DeliveryType": "Dør",
        "Tip": null,
        "MaxWeightInKgs": "35"
      },
      "Price":          {
        "@currencyIdentificationCode": "NOK",
        "PackagePriceWithoutAdditionalServices":             {
          "AmountWithoutVAT": "463.00",
          "VAT": "115.75",
          "AmountWithVAT": "578.75"
        },
        "PackagePriceWithAdditionalServices":             {
          "AmountWithoutVAT": "463.00",
          "VAT": "115.75",
          "AmountWithVAT": "578.75"
        }
      },
      "ExpectedDelivery":          {
        "WorkingDays": "1",
        "UserMessage": null,
        "AlternativeDeliveryDates": null
      }
    }
  ],
  "TraceMessages": {"Message":    [
    "From or To country is not defined in request. Using Norway as default country",
    "Added fee 'brev-varsling' (NOK 13.00) to base price of SERVICEPAKKE since request did not have additional service 'eVarsling' specified.",
    "EKSPRESS09 delivery requested for divided postal code",
    "Product PA_DOREN can not be sent between the given postal codes / countries ",
    "Package exceed maximum measurements for product MAIL "
  ]}
}

It is also possible to combine weight, volume and dimensions for multiple parcels. Multiple parcels are specified by suffixing weightInGrams, volume or dimensions (length, width or height), with sequential numbers from 0.

The data used in this example is:

from=7041
to=0558

Parcels:

weightInGrams0=1500
volume1=33
length2=10&width2=20&height2=30

Param	Info
`produkt code_`	optional Used if price adjustments are only made for a single service.
`p`\|`m`	optional The operation to be performed. `p` is for adding to the price, `m` for subtracting, and if left out the price is replaced with the factorn
`factor`	The factor to be used in the price adjustment. This number can be a fixed amount or percentage to be added/subtracted, or a fixed price to be added/subtracted depending on other parameters.
`p`	optional Indicates that the operation should be done as a percentage calculation. Note that this is only valid for additions and subtractions and not fixed prices.

Query	Result
`&priceAdjustment=10`	Set price to 10
`&priceAdjustment=p20.5`	Add 20.5 to the price
`&priceAdjustment=m20`	Subtract 20 from the price
`&priceAdjustment=SERVICEPAKKE_79`	Set fixed price of SERVICEPAKKE to 79
`&priceAdjustment=SERVICEPAKKE_p30p`	Add 30% to the price of SERVICEPAKKE
&priceAdjustment=SERVICEPAKKE_79&priceAdjustment=EKSPRESS09_m20p	Set fixed price of NOK 79 for SERVICEPAKKE and deduct 20% on Bedriftspakke Ekspress Over Night 09

Shipping Guide API

Introduction

Available services

General Guidelines

VAT

Value added services affecting price

Error Handling Guidelines

No services applicable

General errors

Error codes for rejected requests

Offline data

Useful XPaths when processing offline data

Additional information

Overview of endpoints

Base URL

Get shipment prices

URL

Request parameters

Responses

HTTP status code 200

Get estimated delivery time

URL

Request parameters

Responses

HTTP status code 200

Get shipment prices, estimated delivery and more

URL

Request parameters

Responses

HTTP status code 200

Weight in grams

Package dimensions

Volume

Examples

Weight in grams

Package dimensions

Volume

Examples

SOAP

WSDL

Versioning

Holidays and Home Delivery

URL