GET v4/packages/:pkg_sku - Read

Use this API to request details about a specific package product with a collection of Assets/SKUs. 

Verb/URI

GET https://api.vitalsource.com/v4/packages/:pkg_sku

Data Definitions

Name
Usage
Description
Data Type
Example
Required
  URL param Request information on an existing package N/A

v4/packages/:pkg_sku

Yes 

 

Request Headers

X-VitalSource-API-Key: ABCDEFGHIJKLMNOP
Content-Type: application/json

Response

Response Body

{
"sku": "TEST-1234",
"name": "Name of your package",
"description": "License free content",
"publisher": "YOUR_COMPANY_NAME_HERE",
"list_price": “19.99”,
"in_store": true,
"in_uk_store": false,
"in_au_store": false,
"download_license": {
"details": "Expires on December 31, 2020",
"duration": null
},
"online_license": {
"details": "Expires 180 days after registration",
"duration": "180 days"
},
"tags": [],
"created_on": "2019-07-30T12:00:00Z",
"updated_on": "2019-07-30T12:00:00Z",
"products": []
}

Response descriptions

Name
Description
sku The auto-generated SKU for the new package, or name you passed 
name The name of the package
description Package description to display to end users
Publisher Name of the company who created the package (in VitalSource Manage)
list_price The price for the package if necessary

in_{location}_store

VitalSource store approval status, for all stores specified
download_license, online_license Specific elements to specific the license length and type for downloadable and online clients. Must set a specific value
tags  String field passed at Create/Update
details Text describing license rules set
duration Number of days of num_days was used, otherwise null
product(s) [{sku},{sku2}] Array of SKU's in package. Metadata currently available for each asset in VitalSource Manage is shown for each asset as vbid response body

Error Codes

HTTP & Error messages 
Message
Notes
403

Permission denied

API key to package mismatch
404

Package not found

verify SKU
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.