Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URLhttps://api.order.boknett.no/orders
MethodGET
Request
headers

Authorization

Required

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

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

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

YYYYMMDDHHMMSS

modeOptionalSENT_TO_ME | SENT_BY_ME | ALL (default)
Response
body
Response HAL JSON document 
Response headersContent-typeapplication/hal+json
Returns200OK
40xOn error
Code Block
titleExample response body
{
      "orderNumber" : "56a8abfb79829",
      "buyer" : "7045",
      "orderId" : "4db955a8-dcec-415b-b128-90a42125866c",
      "links" : [
         {
            "href" : "https://api.order.boknett.no/orders/4db955a8-dcec-415b-b128-90a42125866c",
            "rel" : "self"
         }
      ],
      "status" : "FAILED",
      "created" : "2016-02-01Z11:26:00",
      "seller" : "900877"
   },
   {
      "orderId" : "46b678a6-49cc-4b2b-9361-0ca73ccd1e16",
      "buyer" : "7045",
      "links" : [
         {
            "href" : "https://api.order.boknett.no/orders/46b678a6-49cc-4b2b-9361-0ca73ccd1e16",
            "rel" : "self"
         }
      ],
      "orderNumber" : "56ab35d26fdba",
      "status" : "FAILED",
      "created" : "2016-02-01Z11:26:01",
      "seller" : "900877"
   },
   {
      "status" : "SENT",
      "created" : "2016-02-01Z13:44:30",
      "seller" : "900877",
      "orderId" : "73015709-08f3-476f-a152-d9cdc4c7a5f8",
      "buyer" : "116",
      "links" : [
         {
            "rel" : "self",
            "href" : "https://api.order.boknett.no/orders/73015709-08f3-476f-a152-d9cdc4c7a5f8"
         }
      ],
      "orderNumber" : "99999998"
   } 

Get Order

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

...

URLhttps://api.order.boknett.no/orders/{ID}
MethodGET
Request
headers

Authorization

Required

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

DateRequiredThe timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT
Response
body
Response HAL JSON document 
Response headersContent-typeapplication/hal+json
Returns200OK
40xOn error
Code Block
titleExample response body
{
   "buyer" : "116",
   "_links" : {
      "editx" : {
         "href" : "https://api.order.boknett.no/orders/0071e08d-7a24-4d3d-abf1-91fce921b1cc/editx"
      },
      "self" : {
         "href" : "https://api.order.boknett.no/orders/0071e08d-7a24-4d3d-abf1-91fce921b1cc"
      }
   },
   "seller" : "900877",
   "orderId" : "0071e08d-7a24-4d3d-abf1-91fce921b1cc",
   "orderNumber" : "99999995",
   "created" : "2016-02-01Z14:59:05",
   "status" : "FULFILLED"
} 

 

Get Order EDItX document

...