Skip to content

Fulfillment Resource

Introduction

The bookshelf object in Open Publishing contain the purchased digital books of a user. These must not be confused with the library acces - which provides institutional users access to titles of lists of assets.

Example URL

https://api.openpublishing.com/resource/v3/bookshelves/[ID]

Allowed methods: GET.

Search Filters

List bookshelves:

https://api.openpublishing.com/resource/v3/bookshelves

Search for all bookshelves of order:

https://api.openpublishing.com/resource/v3/bookshelves?order_id=[ORDER-ID]

Search for all bookshelves of business partner:

https://api.openpublishing.com/resource/v3/bookshelves?business_partner_id=[BUSINESS-PARTNER-ID]

Fields

Business Partner

business_partner subobject contains link to the business partner to which the fulfillment object is linked to. The object itself contains the _id of the business partner and their screenname.

Order

order subobject contains a link to the order to which the object is referenced. The object itself contains the _id of the order.

Product

The product field and a link to a product. The product itself is a dict containing an _id and the title of the product.

Download Expiration

download_expiration contains the unix timestamp till when the user has access to the asset.

First download

first_download contains the unix timestamp of the first download of the asset by the user.

Last download

last_download contains the unix timestamp of the last recent download of the asset by the user.

Downloads

downloads field contains the number of successful downloads.

EAN

ean contains the EAN of the asset.

Realm

realm is the Open Publishing terminology for tenant. It contains a dict with _id and name and screenname.

Example JSON

{
   "_id": 64,
   "business_partner": {
      "_id": 128,
      "screenname": "John Doe"
   },
   "download_expiration": null,
   "downloads": 0,
   "ean": "9783638101417",
   "first_download": null,
   "last_download": null,
   "order": {
      "_id": 1633388953
   },
   "product": {
      "_id": 190,
      "title": "Rezension zu: Schönbach, Klaus - Zeitungen in den Neunzigern: Faktoren ihres Erfolgs"
   },
   "realm": {
      "_id": 23,
      "name": "testpublisher",
      "screenname": "Test Publisher"
   }
}