All Products
This route will return a list of all products and product details. The details of each product is consisted of:
– product_uuid: product’s unique ID
– product_code: Legacy product Codes used to identify a product
– product_description: Description of the product
– full_product_path: Full path to the product details
– product_categories: List of all categories that the product belongs to
– product_option_groups: Path to list of all Option Groups for a specific product. Option Groups consists Size, Stock, Coating, Colorspec, Runsizes, Turnaround-Times and any finishing option groups that apply to the specified product
– product_base_prices: Path to list of base prices for the specified product considering all runsizes and colorspecs. Any Option Group, such as Turnaround-times or any finishing options that affects the base price, will contain an “option_prices” link in the options array that will specify the option price that needs to be added to the base price
Resource URI
GET /printproducts/products
Sample Request
html
https://api.4over.com/printproducts/products
Sample Response
JSON
{
entities: [
{
product_uuid: "e8c49dac-1bb0-4bea-a980-fd563f58e0e0",
product_code: "100GLBUV-BKUV-11X17",
product_description: "8.5" X 11" - 4 Page Brochure On 100LB GLOSS BOOK with UV on both sides",
full_product_path: "http://api.4over.com/app.php/printproducts/products/e8c49dac-1bb0-4bea-a980-fd563f58e0e0",
categories: "http://api.4over.com/app.php/printproducts/products/e8c49dac-1bb0-4bea-a980-fd563f58e0e0/categories",
product_option_groups: "http://api.4over.com/app.php/printproducts/products/e8c49dac-1bb0-4bea-a980-fd563f58e0e0/productoptiongroups",
product_base_prices: "http://api.4over.com/app.php/printproducts/products/e8c49dac-1bb0-4bea-a980-fd563f58e0e0/baseprices"
},
{
product_uuid: "06b301d3-ade0-4afc-b132-39664e9af90e",
product_code: "100GLBUV-BKUV-2X11X17",
product_description: "8.5" X 11" - 8 Page Brochure On 100LB GLOSS BOOK with UV on both sides",
full_product_path: "http://api.4over.com/app.php/printproducts/products/06b301d3-ade0-4afc-b132-39664e9af90e",
categories: "http://api.4over.com/app.php/printproducts/products/06b301d3-ade0-4afc-b132-39664e9af90e/categories",
product_option_groups: "http://api.4over.com/app.php/printproducts/products/06b301d3-ade0-4afc-b132-39664e9af90e/productoptiongroups",
product_base_prices: "http://api.4over.com/app.php/printproducts/products/06b301d3-ade0-4afc-b132-39664e9af90e/baseprices"
},
{
product_uuid: "25966aeb-b483-4f87-8a3e-3fe57df45ef1",
product_code: "100GLBUV-BKUV-3X11X17",
product_description: "8.5" X 11" - 12 Page Brochure On 100LB GLOSS BOOK with UV on both sides",
full_product_path: "http://api.4over.com/app.php/printproducts/products/25966aeb-b483-4f87-8a3e-3fe57df45ef1",
categories: "http://api.4over.com/app.php/printproducts/products/25966aeb-b483-4f87-8a3e-3fe57df45ef1/categories",
product_option_groups: "http://api.4over.com/app.php/printproducts/products/25966aeb-b483-4f87-8a3e-3fe57df45ef1/productoptiongroups",
product_base_prices: "http://api.4over.com/app.php/printproducts/products/25966aeb-b483-4f87-8a3e-3fe57df45ef1/baseprices"
},
...
]
}
Products In A Category
This route will return list of Products in the specific Category. Product list contains product_uuid, product_code, full_product_path, a link to categories, a link to product_option_groups and a link to product_base_prices.
Resource URI
GET /printproducts/categories/{category_uuid}/products
Input Parameters
@param category_uuid {uuid} The UUID of a category.
Sample Request
html
https://api.4over.com/printproducts/categories/4edd37b2-c6d5-4938-b6c7-35e09cd7bf76/products
Sample Response
JSON
{
entities: [
{
product_uuid: "bc3758a8-8f6c-4e24-8fb5-99d1a95ac01e",
product_code: "100DB-FLSA-11X17",
product_description: "11" X 17" 100lb Dull Book Flyers with Satin AQ coating",
full_product_path: "http://10.7.2.73:8080/app.php/printproducts/products/bc3758a8-8f6c-4e24-8fb5-99d1a95ac01e",
categories: "https://api.4over.com/printproducts/products/bc3758a8-8f6c-4e24-8fb5-99d1a95ac01e/categories",
product_option_groups: "https://api.4over.com/printproducts/products/bc3758a8-8f6c-4e24-8fb5-99d1a95ac01e/productoptiongroups",
product_base_prices: "https://api.4over.com/printproducts/products/bc3758a8-8f6c-4e24-8fb5-99d1a95ac01e/baseprices"
},
{
product_uuid: "552a6ebd-c9ab-4c08-b8d6-ea93b441920e",
product_code: "100DB-FLSA-8.5X11",
product_description: "8.5" X 11" 100lb Dull Book Flyers with Satin AQ coating",
full_product_path: "https://api.4over.com/printproducts/products/552a6ebd-c9ab-4c08-b8d6-ea93b441920e",
categories: "https://api.4over.com/printproducts/products/552a6ebd-c9ab-4c08-b8d6-ea93b441920e/categories",
product_option_groups: "https://api.4over.com/printproducts/products/552a6ebd-c9ab-4c08-b8d6-ea93b441920e/productoptiongroups",
product_base_prices: "https://api.4over.com/printproducts/products/552a6ebd-c9ab-4c08-b8d6-ea93b441920e/baseprices"
},
...
]
}
This route will return details of a specific Product. The response consists product_uuid, product_code, product_description, categories and product_option_groups
Resource URI
GET /printproducts/products/{product_uuid}
Input Parameters
@param product_uuid {uuid} The UUID of a product.
Sample Request
html
https://api.4over.com/printproducts/products/bc3758a8-8f6c-4e24-8fb5-99d1a95ac01e
Sample Response
JSON
{
product_uuid: "bc3758a8-8f6c-4e24-8fb5-99d1a95ac01e",
product_code: "100DB-FLSA-11X17",
product_description: "11" X 17" 100lb Dull Book Flyers with Satin AQ coating",
categories: [
{
category_uuid: "4edd37b2-c6d5-4938-b6c7-35e09cd7bf76",
category_name: "Flyers / Brochures"
}
],
product_option_groups: [
{
product_option_group_uuid: "217f0a2b-224a-47f1-8452-f513d418c98c",
product_option_group_name: "Size",
minoccurs: 1,
maxoccurs: 1,
options: []
},
{
product_option_group_uuid: "6a5ef04a-7143-444b-b4ed-f623204e7168",
product_option_group_name: "Stock",
minoccurs: 1,
maxoccurs: 1,
options: [
{
option_uuid: "7f9062f3-bd6e-4f7e-9934-8f7014391801",
option_name: "100DB",
option_description: ""
}
]
},
{
product_option_group_uuid: "6a5ef04a-7143-444b-b4ed-f623204e7168",
product_option_group_name: "Coating",
minoccurs: 1,
maxoccurs: 1,
options: []
},
{
product_product_option_group_uuid: "d365deb4-604c-4922-98dd-4956681db3fa",
product_product_option_group_name: "Folding Options",
minoccurs: "0",
maxoccurs: "1",
options: [
...
{
option_uuid: "58fbbc8b-0d83-4565-bbf1-e3c03f17a60b",
option_name: "French Fold",
option_description: "Folding Options",
option_prices: "https://api.4over.com/printproducts/products/bc3758a8-8f6c-4e24-8fb5-99d1a95ac01e/productoptiongroups/d365deb4-604c-4922-98dd-4956681db3fa/options/58fbbc8b-0d83-4565-bbf1-e3c03f17a60b/prices"
},
...
]
},
{
product_option_group_uuid: "6a5ef04a-7143-444b-b4ed-f623204e7168",
product_option_group_name: "Colorspec",
minoccurs: 1,
maxoccurs: 1,
options: [
{
option_uuid: "32d3c223-f82c-492b-b915-ba065a00862f",
option_name: "4/0",
option_description: "Colorspec 4/0"
},
{
option_uuid: "2fd6ad29-756c-4927-a66f-b0c0116e31f9",
option_name: "4/1",
option_description: "Colorspec 4/1"
},
{
option_uuid: "13abbda7-1d64-4f25-8bb2-c179b224825d",
option_name: "4/4",
option_description: "Colorspec 4/4"
}
]
},
{
product_option_group_uuid: "6a5ef04a-7143-444b-b4ed-f623204e7168",
product_option_group_name: "Runsizes",
minoccurs: 1,
maxoccurs: 1,
options: []
},
{
product_option_group_uuid: "6a5ef04a-7143-444b-b4ed-f623204e7168",
product_option_group_name: "Turnaround-times",
minoccurs: 1,
maxoccurs: 1,
options: [
...
{
option_uuid: "e04b099b-4ac3-4a35-84d0-c530df7b7aff",
option_name: "527",
option_description: "Turnaround-time 5-7 Business Days",
runsize_uuid: "52e3d710-0e8f-4d4d-8560-7d4d8655be69",
runsize: "1000",
colorspec_uuid: "2fd6ad29-756c-4927-a66f-b0c0116e31f9",
colorspec: "4/1",
option_prices: "https://api.4over.com/printproducts/products/bc3758a8-8f6c-4e24-8fb5-99d1a95ac01e/productoptiongroups/d45cec1f-d12c-45c8-b2fa-9297efd29524/options/3318b994-52d8-49d7-8f42-79a2b76af4df/prices"
},
...
]
}
]
}