CloudCore API base definitions

A number of base definitions and types are used in the CloudCore API. Here is an overview of the definitions and types, as well as there use cases.

Table of content

Price unit types


Price units are used by the CloudCore system in price calculations. Each price unit type has their own method of calculation.

When prices are calculated by CloudCore multiple prices can be combined. An example could be pr item price and a pr quantity. The pr item price would act as a starting price, and the pr quantity is the items price.

Reference Description
price_unit_pr_order Once for an order - The value is calculated once for an order.
price_unit_pr_item Once for each item in an order - The value is calculated in once for the item in the order.
price_unit_pr_quantity For each item quantity - The value is calculated for each quantity of an item in an order.
price_unit_pr_page For each page in the product - The value is calculated for each page in a book and multiplied with the quantity of the item.
price_unit_pr_book For each book, no pages included - The value is calculated once for the item in the order. Only used for the base price of books.

Shipping levels


Shipping levels are used to indicate the shipping service level on orders where a quote hash is not used. If a Shipping service is not available on the level specified, a higher level is used. A higher level is also used if the higher level is cheaper than the requested level.

Reference Description
cp_fast Express fast - Tracked
cp_saver Express saver - Tracked
cp_ground Express ground - Tracked
cp_postal Postal - Untracked

Option types


Options are categorized in the following types.

When specifying options on an order item, only one option of a specific type can be specified. Not all option types apply to all products. The relation between productions and options can be found via the products/info endpoint in the CloudCore API or via the admin dashboard.

Reference Description
type_book_binding Book binding method
type_book_paper Bookblock paper
type_book_cover_finish Book cover finishing
type_book_page_finish Bookblock finishing
type_book_addon Book addon
type_canvas_material Canvas material
type_cover_paper Book cover paper
type_product_paper Product paper
type_poster_paper Poster paper
type_gifting_paper Gifting paper
type_canvas_addon Canvas addon
type_cover_material Cover linen color