A product group may contain many products, and every product belongs to one product group.
We recommend that you group products by similar production or marketing details. For example, all products with a certain finishing type could belong to the same product group, regardless of their page_size, colour_type, or quantity.
Request 'product group' by code
Syntax
/product_groups/<product_group.code>
Retrieves a product group.
Parameter |
Description |
format |
json or xml |
HTTP request
GET http://dev.flyerlink.com/api.php/product_groups/BC?format=json
HTTP response (JSON)
{
"product_group" : {
"code" : "BC",
"name" : "Regular Business Cards",
"url_slug" : "regular-business-cards",
"prodcat" : "BUSCARD"
}
}
Response Item |
Description |
product_group |
Container item |
|
code |
Unique identifier for the product category. |
|
name |
The product category’s name, in the current language. |
|
url_slug |
The url string (for your public websites) that displays the page for this product group. E.g. my.domain.com/url-slug |
|
prodcat |
The product category that this product group belongs to. |
Create 'product group'
POST Syntax
/product_groups
Creates a new product group, ready for new products.
* = required parameter.
Parameter |
Type |
Description |
format |
string |
json or xml |
name* |
char(40) |
Name for the new product group |
prodcat |
char(8) |
An existing product_category.code. |
workgrp |
char(8) |
The workgroup.code for the workgroup who makes the product: your own workgroup.code, or your supplier’s workgroup.code. |
description |
memo |
This is a concise product description. We suggest you follow the standard style of specification that printing.com products use. |
commonname |
char(70) |
The name that is common to the intended market rather than the (perhaps unknown) name that you give your product. |
restrictions |
memo |
Any limitations that customers should know about a product, such as how many fabrics an embroidered item of clothing can use. |
supplierofwg |
char(8) |
workgroup.id for the group of users a product can be supplied to. This is only used if the product group is being made by a OpenSource Supplier. Enter the code of the selling workgroup who that supplier belongs to. |
bulletpoint |
char(60) |
Short feature list for sales websites. |
meta_title |
char(100) |
SEO meta-data |
meta_description |
char(128) |
SEO meta-data |
preflight_type |
char(2) |
If users will use FileCheck for this product group, choose one of the published preflight profiles; see Enumerated types: Preflight Types. |
supplieready_preflight_type |
char(2) |
These additional preflight types perform conversions to the layout of the artwork, to conform to generic supplier specifications. See Enumerated types: Supplieready Preflight Types. |
opensource |
Boolean |
true for OpenSource; false for Marketplace. |
HTTP request
POST http://dev.flyerlink.com/api.php/product_groups/BC
format=xml
HTTP response (XML)
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<id>772</id>
</response>
Response Item |
Description |
response |
Container item with status attribute. |
|
id |
Unique identifier for the product group. |