Page Comparison

Table of Contents

Info
New Authentication & URLs introduced Q2 2024

Get Orders

Get a list of orders based on our access rights, you need to use the query parameter mode to select if you wanter orders that you have sent to check their status (SENT_BY_ME) or orders you are receiving (SENT_TO_ME).

URL

Request
headers

Authorization

Required

https://api.bokbasen.io/orders/v1

Expand

title	Legacy

https://api.order.boknett.no/orders

Method

GET

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

Required header: Date

Required

The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT

Method

GET

Request
headers

Authorization

Required

See Authentication Service

Audience: https://api.bokbasen.io/orders/

Request query parameters

fromDate

Required

From date you you want to get the list of orders based on (based on last update date of the order)

YYYYMMDDHHMMSS

mode

Required

SENT_TO_ME | SENT_BY_ME

Response
body

Response HAL JSON document (see example below)

Response headers

Content-type

application/hal+json

Returns

200

OK

40x

On error

...

Code Block

curl -i \
  -H "Authorization: Boknett TGT-6150-TxNGbSboEPY24GB9OsO3JyLcyFCbfeSIBHp0TBoVM6Dfgb4mL9-login.webbe.no" \
  -H "Date: Thu, 28 Apr 2016 08:01:22 GMT" Bearer <token>" \
  'https://api.orderbokbasen.boknett.noio/orders/v1?mode=SENT_BY_ME&fromDate=20150101120000'
 
HTTP/1.1 200 OK
Date: Thu, 28 Apr 2016 08:02:44 GMT
Content-Type: application/hal+json

(see below for response body example)

...

Get single order based on Bokbasen's order-id. This view gives all available details on the order and order lines.

URL

Request
headers

Authorization

Required

https://api.bokbasen.io/orders/v1/{id}

Expand

title	Legacy

https://api.order.boknett.no/orders/{id}

Method

GET

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

Required header: Date

Required

The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT

Method

GET

Request
headers

Authorization

Required

See Authentication Service

Audience: https://api.bokbasen.io/orders/

Response
body

Response HAL JSON document

Response headers

Content-type

application/hal+json

Returns

200

OK

40x

On error

Curl example

Code Block

$curl -i \
      -H "Authorization: Boknett TGT-6150-TxNGbSboEPY24GB9OsO3JyLcyFCbfeSIBHp0TBoVM6Dfgb4mL9-login.boknett.no" -H "Date: Thu, 28 Apr 2016 08:01:22 GMT"Bearer <token>" \
      'https://api.orderbokbasen.boknett.noio/orders/v1/5df2f39a-7c12-400c-a675-d12e331eb151'
 
HTTP/1.1 200 OK
Date: Thu, 28 Apr 2016 08:02:44 GMT
Content-Type: application/hal+json
 
(see below for response body example)

...

Code Block

{
  "_embedded" : {
    "lines" : [ {
      "lineNumber" : 1,
      "status" : "SENT",
      "ean" : "9788202337926",
      "quantity" : 1
    }, {
      "lineNumber" : 2,
      "status" : "SENT",
      "ean" : "9788202339296",
      "quantity" : 1
    } ]
  },
  "shipToParty" : {
    "id" : "948061937",
    "name" : "Norsk Videregående skole",
    "contactPerson" : "Kari Nordmann",
    "address" : {
      "zip" : "0180",
      "street" : "St. Hanshaugen",
      "city" : "OSLO"
    },
    "communication" : [ {
      "type" : "Email",
      "value" : "kari.nordmann@skole.no"
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.orderbokbasen.boknett.noio/orders/v1/c2b972ee-b2ec-11e5-9c35-0050569f5799"
    },
    "editx" : {
      "href" : "https://api.orderbokbasen.boknett.noio/orders/v1/c2b972ee-b2ec-11e5-9c35-0050569f5799/editx"
    }
  },
  "orderId" : "c2b972ee-b2ec-11e5-9c35-0050569f5799",
  "buyerOrderNumber" : "6252911_0",
  "buyer" : "104",
  "created" : "2015-10-13Z07:32:26",
  "status" : "SENT"
}

...

Get the EDItX XML representation of a given order based on Bokbasen's order-ID.

Requestheaders

URL

https://api.bokbasen.io/orders/v1/{id}/editx

Expand

title	Legacy

https://api.order.boknett.no/orders/{id}/editx

Method

GET

Authorization

Required

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

Required header: Date

Required

The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT

Method

GET

Request
headers

Authorization

Required

See Authentication Service

Audience: https://api.bokbasen.io/orders/

Response
body

EDItX XML document

Response headers

Content-type

application/xml;charset=UTF-8

Returns

200

OK

40x

On error

...

Code Block

curl -i \
  -H "Authorization: Boknett TGT-6150-TxNGbSboEPY24GB9OsO3JyLcyFCbfeSIBHp0TBoVM6Dfgb4mL9-login.boknett.noBearer <token>" \
  -H "Date: Thu, 28 Apr 2016 08:01:22 GMT" \
  'https://api.orderbokbasen.boknett.noio/orders/v1/5df2f39a-7c12-400c-a675-d12e331eb151/editx'
 
HTTP/1.1 200 OK
Date: Thu, 28 Apr 2016 08:02:44 GMT
Content-Type: application/xml;charset=UTF-8

...

Versions Compared

Old Version 23

New Version Current

Key

Get Orders

Curl example