3.0 - Order Feed

Data specification

The following table describes the data specification in Order Feed 3.0. A full overview of the Order Feed and recommendations for processing can be found here. Order Feed 3.0 includes `ci_student_price` which describes how much a student will be charged for the purchase of a digital course material.

Column name	Data type	Definition
order_id	Integer	A unique Unizin ID for the order.
order_created	Datetime	A date & time in ISO 8601.
order_updated	Datetime	A date & time in ISO 8601.
sis_section_id	Text	An SIS section ID that is on an order.
sis_content_id	Text	This data is only applicable to Indiana University. In many cases, the value will be `null`.
content_id	Text	This value is a unique identifier for each content item available in Unizin's Master Catalog.
is_deleted	Boolean	If "true," the Order to which the content-section pair belongs has been canceled.
order_item_type	Text	A value, from an enumerated set, describing the type of item on a particular order. Possible values include catalog_item and content_request.
ci_author	Text	The author of a content item that is on the order. If multiple authors are present, they are separated by a semicolon.
ci_title	Text	The title of a content item that is on the order.
cr_created	Datetime	The timestamp that the content request was created. This is a timestamp in ISO 8601.
cr_title	Text	The title of the Content request, as input by the user.
cr_isbn	Text	The ISBN of the Content request, as input by the user.
cr_status	Text	The Status of the Content request. Values include Submitted, Researching, Approved, Canceled or Denied.
ci_searchable_isbn	Text	The best ISBN students can use to search for and find the title on the web.
ci_publication_date	Date	The publication date of the title, if available from the publisher. This is a date in ISO 8601 (note: it is only a date object).
ci_delivery_solution	Text	The name of the reader used to deliver the solution. Values will be either "Unizin Engage" or "Publisher DLT".
ci_sis_publisher_id	Text	This is only applicable for Indiana University. In many cases, it will be `"null"`.
ci_publisher_name	Text	The name of the content item’s publisher.
ci_edition	Text	The edition of the content item.
ci_print_list_price_original	Number	If the print list price has been updated, this column will show the original print list price it was updated from.
ci_print_list_price	Number	The print list price for the content item (this is the nominal price of the content item. Offer prices are generally calculated as a function of the print list price).
ci_offer_price_original	Number	If the offer price has been updated, this column will show the original offer price it was updated from.
ci_offer_price	Number	The offer price for the content item and the exact price that Unizin will charge institutions for the content (this includes any Unizin markups or platform fees).
ci_student_price_original	Number	If the student price has been updated, this column will show the original student price it was updated from.
ci_student_price	Number	The student price for the content item (this is the price students will be charged, which is calculated as the offer price plus the institutional markup, if applicable).
is_royalty	Boolean	This is a boolean value corresponding to whether or not the person who ordered the content item for this section asserted that they may earn royalties. Note: this is an order-level assertion but presented for each content item. In short, it should not be assumed that if this value is true, it is because the user ordering the content stands to earn royalties from this particular content item.