We have provided a number of product categories that should suit all likely web-2-print products. Please map your product groups to the product category that is the best fit.

If you cannot find a product category to suit, please request a new product category by contacting API Support.

Request product category by code

/product_categories/<product_category.code>

Retrieves a product category.

GET http://dev.flyerlink.com/api.php/product_categories/BUSCARD?format=json

{
    "product_category" : {
        "code" : "BUSCARD",
        "prodzone" : "BUSCARD",
        "name" : "Business Cards"
    }
}

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

/product_groups/<product_group.code>

Retrieves a product group.

GET http://dev.flyerlink.com/api.php/product_groups/BC?format=json

{
    "product_group" : {
        "code" : "BC",
        "name" : "Regular Business Cards",
        "url_slug" : "regular-business-cards",
        "prodcat" : "BUSCARD"
    }
}

Create 'product group'

/product_groups

Creates a new product group, ready for new products.

* = required parameter.

POST http://dev.flyerlink.com/api.php/product_groups/BC
format=xml

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <id>772</id>
</response>

Request all products

/products/

Retrieves all products, optionally filtered, limited to 300 items.

GET http://dev.flyerlink.com/api.php/products?format=json

Request 'product' by code

/products/<product.code>

GET http://dev.flyerlink.com/api.php/products/MBG3L5T?format=json

{
    "product" : {
        "id" : "MBG3L5T",
        "name" : "Premium Gloss Folded Leaflet :: 3 Panel Land A5",
        "filetype" : "PDF",
        "width" : "630.0000",
        "height" : "148.0000",
        "bleed" : "1.5000",
        "rununits" : "1",
        "reverse" : "4",
        "allowmulti" : "t",
        "partnercode" : null,
        "prices" : {
            "selling" : [223, 259, 281, 303, 317, 330, 343, 356, null, null],
            "transfer" : [ ... ]
        },
        "variations" : [{
                "code" : "A",
                "finishes" : [{
                        "code" : "FROLL3",
                        "name" : "3 Panel Roll Fold"
                    }, {
                        "code" : "FZFOLD",
                        "name" : "3 panel Z Fold"
                    }, {
                        "code" : "FMBCUSTM",
                        "name" : "Custom Fold"
                    }, {
                        "code" : "NF",
                        "name" : "Do Not Fold - supply flat"
                    }
                ]
            }
        ]
    }
}

Optional parameter: quantity

When quantity is used with code, the response includes the quantities item, containing calculated pricing for the required quantity.

Note that quantity should be a multiple of units, up to the limit of (maxbatch * units); see POST /products/.

GET http://dev.flyerlink.com/api.php/products/FZMBGA4V?quantity=1000&format=json

{
    "product" : {
        "id" : "FZMBGA4V",
        ...
        "prices" : { ... },
        "variations" : [{ ... }],
        "quantities" : [{
                "quantity" : 1000,
                "batches" : 2,
                "selling_price" : 84,
                "transfer_price" : 40.2
            }
        ]
    }
}

Optional parameter: language

When language is used with code, the response includes the notes item.

GET http://dev.flyerlink.com/api.php/products/CSBUS41?language=en_GB&format=json

{
    "product" : {
        "id" : "CSBUS41",
        ...
        "prices" : { ... },
        "variations" : [{ ... }],
        "notes" : {
            "design" : "...",
            "special" : "..."
        }
    }
}

Create 'product'

Creates a new product.

• You’ll need a product category and product group before creating the product.
• After creating the product, add prices and tags.

Name, description, notes (etc) will be added only in your own language.

* indicates required.

/products/<product.code>

POST http://dev.flyerlink.com/api.php/products/MBG3L5T
name=API%20Product%20Example&description=Product%20Description&notes=Design%20Notes&special=Special%20Instructions&producttype_id=1&websitecolour=5&mindays=0&days=4&maxdays=99&backstopdays=4&units=1000&maxbatch=0&rev=1&defunct=0&nocarecall=0&editrev=0&pageno=19&prodgr=00&gdelivery=t&partnercode=555&height=50&width=70&format=json

Request 'product pricing' by 'product code'

/products/<product.id>/prices

Retrieves pricing for the requested product. All available service levels are returned, though usually only one will be present.

selling = price that a workgroup sells at. 
transfer = price that a workgroup buys at. 
production = cost that a workgroup incurs from third party suppliers (Marketplace, or workgroup suppliers).

GET http://dev.flyerlink.com/api.php/products/MBG3L5T?/prices?format=json

{
    "services" : [{
            "adddays" : "2",
            "batches" : [{
                    "selling" : 64,
                    "transfer" : <float>,
                    "production" : 0,
                    "_attrs" : {
                        "batch" : 1
                    }
                }
                ... <other 'batch' items> ...
                }, {
                    "selling" : 164,
                    "transfer" : <float>,
                    "production" : 0,
                    "_attrs" : {
                        "batch" : 10
                    }
                }, {
                    "selling" : 7, 
                    "transfer" : <float>,
                    "production" : 0,
                    "_attrs" : {
                        "batch" : "runon"
                    }
                }
            ]
        }
    ]
}

Set 'product pricing' by 'product code'

/products/<product.id>/prices/

Sets pricing for the requested product. 

Important: Each price has three aspects, and all possible combinations of [turnaround], [batches], [transaction type] for the product must be set in one request. The pricing for a product is wiped immediately before your new data is entered, so any omitted combinations will be erased.

Be sure to include data for your product’s ‘base turnaround’ where turnaround = product.days. This is the only turnaround that you must specify; pricing for other turnaround values (within your allowed range) is optional.

The format of each entry is:

prices[turnaround][batches][type]=value.

All three must be included in a request.

• Your assigned territory.
• production turnaround, in working days.
• batches (quantity = batches × product.units). 
• transaction type: { selling | transfer | production }.
• value: price amount.

Below is the simplest example, for a turnaround of 2 production days, and only 1 batch. Note: we've put line-feeds before each & for legibility.

POST http://dev.flyerlink.com/api.php/products/MBG3L5T/prices
territory=TEMP
&prices[2][1][selling]=50
&prices[2][1][transfer]=40
&prices[2][1][production]=0
&format=json