This route will return list of all Option Groups. Option Groups are consisted of entities such as Size, Stock, Runsizes, Coating, Colorspec and Turnaround-times as well as all bindery and finishing options such as Folding Options and so on. Each Option Group is a collection of such options. Therefore; Folding Option is a collection of all available Folding Options.
Resource URI
GET /printproducts/optiongroups
Sample Request
html
https://api.4over.com/printproducts/optiongroups
Sample Response
JSON
[
"entities",
[
{
option_group_uuid: "34f407f8-0b50-4227-9378-10fddefbe596",
option_group_name: "Size",
option_group_description: "Final width and height dimensions",
options: "https://api.4over.com/printproducts/optiongroups/34f407f8-0b50-4227-9378-10fddefbe596/options"
},
{
option_group_uuid: "24865ffa-793d-43ea-b3b1-d1b5cf22268d",
option_group_name: "Stock",
option_group_description: "The substrate to be printed on",
options: "https://api.4over.com/printproducts/optiongroups/24865ffa-793d-43ea-b3b1-d1b5cf22268d/options"
},
{
option_group_uuid: "26ca0df3-0682-4f37-8979-409868e2df2d",
option_group_name: "Coating",
option_group_description: "Coating options",
options: "https://api.4over.com/printproducts/optiongroups/26ca0df3-0682-4f37-8979-409868e2df2d/options"
},
{
option_group_uuid: "38d33954-5a42-4112-a905-215eb827e62c",
option_group_name: "Colorspec",
option_group_description: "Print color options",
options: "https://api.4over.com/printproducts/optiongroups/38d33954-5a42-4112-a905-215eb827e62c/options"
},
{
option_group_uuid: "87e09691-ef33-4cf4-8f17-48af06ce84f4",
option_group_name: "Runsize",
option_group_description: "The number of impressions to be printed",
options: "https://api.4over.com/printproducts/optiongroups/87e09691-ef33-4cf4-8f17-48af06ce84f4/options"
},
{
option_group_uuid: "d365deb4-604c-4922-98dd-4956681db3fa",
option_group_name: "Folding Options",
option_group_description: "Folding Options",
options: "https://api.4over.com/printproducts/optiongroups/d365deb4-604c-4922-98dd-4956681db3fa/options"
},
...
]
]
This route will return list of all Options in a specific Option Group.
Resource URI
GET /printproducts/optiongroups/optiongroup_uuid/options
Input Parameters
@param optiongroup_uuid {uuid} The UUID of a Option Group.
Sample Request
html
https://api.4over.com/printproducts/optiongroups/d365deb4-604c-4922-98dd-4956681db3fa/options
Sample Response
JSON
[
{
option_uuid: "7f9062f3-bd6e-4f7e-9934-8f7014391801",
option_name: "100DB",
option_description: "",
option_prices: "https://api.4over.com/printproducts/optiongroups/24865ffa-793d-43ea-b3b1-d1b5cf22268d/options/7f9062f3-bd6e-4f7e-9934-8f7014391801/prices"
},
{
option_uuid: "3be06301-cd4f-47f7-a3d7-130aff944a49",
option_name: "100GLB",
option_description: "",
option_prices: "https://api.4over.com/printproducts/optiongroups/24865ffa-793d-43ea-b3b1-d1b5cf22268d/options/3be06301-cd4f-47f7-a3d7-130aff944a49/prices"
},
{
option_uuid: "108654d1-9a11-449d-a835-f662c780c373",
option_name: "100GLBUV",
option_description: "",
option_prices: "https://api.4over.com/printproducts/optiongroups/24865ffa-793d-43ea-b3b1-d1b5cf22268d/options/108654d1-9a11-449d-a835-f662c780c373/prices"
},
{
option_uuid: "6ef3ac86-0540-4936-8f72-172257b3be60",
option_name: "100GLC",
option_description: "",
option_prices: "https://api.4over.com/printproducts/optiongroups/24865ffa-793d-43ea-b3b1-d1b5cf22268d/options/6ef3ac86-0540-4936-8f72-172257b3be60/prices"
},
...
]
This route will return list of all Options associated to a specific product.
Product specific option groups include Size, Stock, Coating, Colorspec, Runsize, Turnaround-times and any bindery/finishing options available to the specified product.
Product specific option groups have two important attributes called “minoccurs” and “maxoccurs”. These two attributes define if the option group is required or optional and what are the limitations. Attribute “minoccurs” defined minimum occurrence of the option group. If “minoccurs” is zero the option group is optional. If “minoccurs” is one at least one instance of the option group has to be selected.
On the other hand, “maxoccurs” defines maximum occurance of the option group. The value of “maxoccurs” could be one or more. If an option group has “minoccurs”=1 and “maxoccurs”=1 then exactly one option has to be selected. Option groups such as Size, Stock, Coating, Colorspec, Runsize and Turnaround-times are examples of such option groups.
Finishing options such as Foldings and Scorings that may or may not be selected for a product would generally have “minoccurs’=0 and “maxoccurs”=1 or more than one. The value of “maxoccurs” is always equal or greater than “minoccurs”.
Resource URI
GET /printproducts/products/{product_uuid}/optiongroups
Input Parameters
@param product_uuid {uuid} The UUID of product.
Sample Request
html
https://api.4over.com/printproducts/products/97797e2e-3e3b-429e-a38a-d5f8d8744de5/optiongroups
Sample Response
JSON
[
"entities",
[
{
product_option_group_uuid: "34f407f8-0b50-4227-9378-10fddefbe596",
product_option_group_name: "Size",
minoccurs: "1",
maxoccurs: "1",
options: []
},
{
product_option_group_uuid: "24865ffa-793d-43ea-b3b1-d1b5cf22268d",
product_option_group_name: "Stock",
minoccurs: "1",
maxoccurs: "1",
options: []
},
{
product_option_group_uuid: "26ca0df3-0682-4f37-8979-409868e2df2d",
product_option_group_name: "Coating",
minoccurs: "1",
maxoccurs: "1",
options: []
},
{
product_option_group_uuid: "38d33954-5a42-4112-a905-215eb827e62c",
product_option_group_name: "Colorspec",
minoccurs: "1",
maxoccurs: "1",
options: []
},
{
product_option_group_uuid: "87e09691-ef33-4cf4-8f17-48af06ce84f4",
product_option_group_name: "Runsize",
minoccurs: "1",
maxoccurs: "1",
options: []
},
{
product_option_group_uuid: "254afeea-1fd1-4efb-b5fb-c9c3bf4c13d2",
product_option_group_name: "Bundling Options",
minoccurs: "0",
maxoccurs: "1",
options: [
{
option_uuid: "58689abb-25c0-461c-a4c3-a80b627d6649",
option_name: "No Bundling Services",
option_description: "BUNDLING SERVICE",
option_prices: "https://api.4over.com/printproducts/products/97797e2e-3e3b-429e-a38a-d5f8d8744de5/productoptiongroups/254afeea-1fd1-4efb-b5fb-c9c3bf4c13d2/options/58689abb-25c0-461c-a4c3-a80b627d6649/prices"
},
{
option_uuid: "e4577a52-3f44-4506-b5a0-d5ef86cef3d2",
option_name: "Yes, Bundles of 100",
option_description: "BUNDLING SERVICE",
option_prices: "https://api.4over.com/printproducts/products/97797e2e-3e3b-429e-a38a-d5f8d8744de5/productoptiongroups/254afeea-1fd1-4efb-b5fb-c9c3bf4c13d2/options/e4577a52-3f44-4506-b5a0-d5ef86cef3d2/prices"
},
{
option_uuid: "5d566e05-ffea-4705-a23f-95bd227f1370",
option_name: "Yes, Bundles of 50",
option_description: "BUNDLING SERVICE",
option_prices: "https://api.4over.com/printproducts/products/97797e2e-3e3b-429e-a38a-d5f8d8744de5/productoptiongroups/254afeea-1fd1-4efb-b5fb-c9c3bf4c13d2/options/5d566e05-ffea-4705-a23f-95bd227f1370/prices"
}
]
},
{
product_option_group_uuid: "6a5ef04a-7143-444b-b4ed-f623204e7168",
product_option_group_name: "Turnaround-times",
minoccurs: 1,
maxoccurs: 1,
options: []
}
]
]