Versions Compared

Key

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

Update the order status for a single line in an order.

 


URLhttps://api.order.boknett.no/orders/{ID}/lines/{lineId}
MethodPOST
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
Content-typeRequiredapplication/json
Request body
 


{"status": "STATUS_VALUE", "comment": "Free text comment included in order details"}


Example for digital learning products (additional fields are optional but allows extra information around when a buyer can use the product to be sent when confirming the order. Important when this deviates from standards that can be read from metadata):

{"status": "STATUS_VALUE", "comment": "Free text comment included in order details", "
valid_to":"2019-12-12", "valid_from": "2019-05-05", "price": {amount: 250.15, tax: 25} }


(comment field is optional)

Response
body
empty on success
Returns200Ok
40xOn error

...


Allowed values for status

ValueDescriptionConditions
FULFILLEDThe order line is delivered to the end customer.Order line must have been processed without errors.
FULFILLED_BLOCKEDThe order line is delivered to the end customer and the seller does not allow any changes to be made to this line.
 
 Order line must have been processed without errors.

FULLFILLED_ASSIGNED_ORGANIZATION

Special status used for products that are automatically assigned to all users in the customer organisation (typically an entire school). Digitalelev will not send any assignments on these products but will allow provider to send updates on number of licenses that are used (in case of usage restrictions).

Order line must have been processed without errors.
RECEIVEDThe order line is received by the seller party
 

REJECTEDThe seller does not accept this order lines, it is highly recommended that you also provide a comment when using this status.