Retrieve Asset

Retrieves the asset metadata with relevant product information, such as available products and prices. The result of the query will be based on the access control of the user making the call. When a content owner makes the call, the asset and its products will be returned with no restriction. Checks are then performed on the user's set and manual rights which will determine whether the user has access to the asset and the products associated.

• Verb/URI
• Data Definitions
• Request Headers
• Response Body
• Response Codes and Messages

Verb/URI

GET https://api.vitalsource.com/v4/assets/:vbid

Data Definitions

{
"vbk": "initialized,
"distribution": "initialized"
}

{
 "e_isbn_10": [
  "0123456789",
  "123456789X"
 ],
 "e_isbn_13": [
  "9780123456789",
  "9781234567890"
 ],
 "print_isbn_10": null,
 "print_isbn_13": null,
 "vbid10_alias" [],
 "vbid13_alias" []
}

"sales_rights": {
 "exclusive_rights": ["CA", "US"],
 "non_exclusive_rights": ["WORLD"],
 "not_for_sale": ["ROW"]
}

[{
  "product_id": 1,
  "sku": 978123456,
  "duration": perpetual,
  "online_duration": 180 days,
  "updated": "2017-06-22T14:43:32Z",
  "prices": [{
      "price": 1.25,
      "currency": "USD",
      "type": "digital_list_price"
  }]
}]

"channel_ids": [
 {
  "sku": "9780123456789",
  "channel_id_inclusive_access": null
 }
]

[{
 "price": 1.25,
 "currency": "USD",
 "type": "digital_list_price"
}]

Request Headers

X-VitalSource-API-Key: ALLNUMBERSANDCAPS
Accept: application/json

Response Body

{
 "vbid": "9780123456789",
 "asset_status": {
  "vbk": "initialized",
  "distribution": "initialized"
 },
 "author_name": "Todd Watkins",
 "author_first_name": "Todd",
 "author_last_name": "Watkins",
 "block_search": false,
 "book_format": {
  "name": null,
  "value": null,
  "dash2epub": false
 },
 "build": {
  "available": true,
 "source": "Ubermilo",
 "status": "approved"
 }"initialized",
 "copy_drm_limit": 5,
 "copyright_date": "2009",
 "created": "2019-05-16T19:43:57Z",
 "cs_plus_discount": "50.00",
 "custom": false,
 "description": "A test paragraph that accurately describes the contents of the asset",
 "discount_codes": [
  "01",
  "AWS",
  "2020B2"
 ],
 "e_isbn": "9780323059398E",
 "edition": 4,
 "epub_page_labels": true,
 "floe": true,
 "fro": false,
 "fulfillment_only": true,
 "id": 340614,
"identifiers": { 
 "e_isbn_10": [
 "0123456789", 
 "123456789X"
 ],
 "e_isbn_13": [
  "9780123456789", 
  "9781234567890"
 ],
 "print_isbn_10": null,
 "print_isbn_13": null,
 "vbid10_alias": [],
 "vbid13_alias": [],
 }
 "imprint": {
  "id": 1234,
  "name": "The Best Imprint",
  "resource_url": "https://manage.vitalsource.com/api/v4/imprints/1234"
 },
 "isbn": "3410341004",
 "isbn_canonical": "3410341004",
 "kind": {
  "id": 1,
  "value": "book"
 },
 "language": "English",
 "lifetime_print_limit": 50,
 "login_url": "https://www.vitalsource.com/signin",
 "next_isbn": "3410341003",
 "off_sale_date": "2029-12-31",
 "on_sale_date": "2029-12-31",
 "parent_id": "9780234501",
 "print_drm_limit": -1,
 "print_isbn": "9780721604220",
 "publication_date": "2009-12-31",
 "publisher": {
  "id": 1240,
  "city": "Chicago",
  "name": "Cody Test"
 },
 "related_products": {
  "next_edition": "3410341003",
  "previous_edition": "3410341005",
 },
 "title": "What a Wonderful Title",
 "sales_rights": {
  "exclusive_rights": ["CA", "US"],
  "non_exclusive_rights": ["WORLD"],
  "not_for_sale": ["ROW"]
 },
 "sampleable": false,
 "subtitle": "Almost As Good As The Subtitle",
 "variants": [
  {
   "product_id": 638855,
   "sku": "3410341004",
   "channel_ids": [
   {
   "channel": "inclusive_access",
   "identifier": "identifier1"
   },
  {
  "channel": "vst_sampling",
  "identifier": "identifier2"
  }
 ],
 "duration": "perpetual",
 "online_duration": "365 days",
 "updated": "2019-05-23T18:55:57Z",
 "prices": [
 {
  "price": "10.00",
  "currency": "USD",
  "type": "digital_list_price",
  "company_id": "_all"
 },
 {
  "price": "20.00",
  "currency": "USD",
  "type": "agency_price",
  "company_id": "_all"
 },
 {
  "price": "20.00",
  "currency": "USD",
  "type": "print_list_price",
  "company_id": "_all"
 }
 ]
 },
 {
  "product_id": 639011,
  "sku": "3410341004R180",
  "channel_ids": [
 {
  "channel": "inclusive_access",
  "identifier": "identifier3"
 }
 ],
 "duration": "180 days",
 "online_duration": "180 days",
 "updated": "2019-05-22T18:08:47Z",
 "prices": [
  {
  "price": "404.00",
  "currency": "AUD",
  "type": "digital_list_price",
  "company_id": "_all"
  },
  {
  "price": "303.00",
  "currency": "GBP",
  "type": "digital_list_price",
  "company_id": "_all"
  },
  {
  "price": "30.00",
  "currency": "USD",
  "type": "digital_list_price",
  "company_id": "_all"
  },
  {
  "price": "10.00",
  "currency": "USD",
  "type": "agency_price",
  "company_id": "_all"
  },
  {
  "price": "20.00",
  "currency": "USD",
  "type": "print_list_price",
  "company_id": "_all"
  }
 ]
 }
 ],
 "vcs_authored": true
}

Response Codes and Messages