Api Documentation

Authentication to the API is performed via HTTP Basic Auth. Your API username and password will be provided to you upon endpoint setup. Provide your API credentials as the basic auth.

Your credentials carry many privileges, so be sure to keep them secure! Do not share your secret API credentials.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

This is a list of objects representing our entire range. You can retrieve it to see the most up-to-date information regarding our products.

This list will be custom to you as all of our endpoints are bespoke build to meet as many of your requirements as possible.

Attributes
sku string Unique identifier for the product.
url string The URL for accessing the product on our website.
isConfectionery boolean Whether or not the product is a confectionery item. Some attributes can be ignored if this is false.
variant string [confectionery only] Unique identifier for the product variant.
variantText string [confectionery only] A string often used for displaying to users.
title string A string often used for displaying to users.
description string A string often used for displaying to users.
categoryMain string The category the product is associated to.
categorySub string The subcategory the product is associated to.
quantityIncrements integer, default is 1 The multiple that the product must be ordered in, some mugs come in a box of 6 so the quantity increment would be 6.
printingMandatory boolean, default is false Whether or not the product must be printed.
printingMandatoryPositions integer, default is 0 If printing is mandatory on the product, number of positions that are mandatory.
pricing array of objects An array of objects to get plain stock prices for the product. pricing.quantity interger Price break quantity. pricing.price decimal Price break price. pricing.delivery decimal Price break delivery charge calculated against quantity.
printing array of objects An array of objects to get print types and prices available for the product. printing.code string Print code. printing.name string An arbitrary string attached to the object. Often useful for displaying to users. printing.image string The URL for accessing an image showing the print area on the product on our CDN. Dimensions - 500px x 500px. Best used for detail pages. printing.position string Print position. printing.max string Maximum colours achievable on the print object. printing.area string Print area in mm. printing.pricing array of objects An array of objects to get print prices for the product. printing.pricing.quantity interger Price break quantity. printing.pricing.price decimal Price break first colour price. printing.pricing.extraColourPrice decimal Price break extra colour price where applicable. printing.handling decimal Price of handling charge associated with print object. printing.origination decimal Price of origination charge associated with print object. printing.originationRepeat decimal Price of repeat origination charge associated with print object.
colours array of objects An array of objects to get colours and stock available for the product. colours.code string Unique identifier for the colour. colours.baseCode string Unique identifier for the base colour. e.g. if colour is "light blue", base code will be "005" (blue). This is often used to help with filtering products. colours.name string An arbitrary string attached to the object. Often useful for displaying to users. colours.size string, default is "One size" Used if the item comes in different sizes. colours.stock interger Stock level of product colour. colours.reserved interger Currently reserved stock level of product colour. colours.backOrder array of objects, default is null An array of objects to get date and quantity of back ordered colour stock. colours.backOrder.quantity interger Back order quantity. colours.backOrder.deliveryDate datetime Back order expected delivery date.
sizes array of strings An array of strings to get sizes available for the product.
images array of objects An array of strings identifying the plain stock images available for the product. images.srcFull string The URL for accessing the image on our CDN. Dimensions - 1500px x 1500px. images.srcDetail string The URL for accessing the image on our CDN. Dimensions - 800px x 800px. Best used for detail pages. images.srcIndex string The URL for accessing the image on our CDN. Dimensions - 500px x 500px. Best used for index pages. images.srcThumb string The URL for accessing the image on our CDN. Dimensions - 120px x 120px. Best used for thumbnails. images.colourCode string Unique identifier for the colour associated with the image. images.flavourColourCode string [confectionery only] Unique identifier for the colour of the flavour associated with the image (if applicable e.g. flavour is sold only as blue filling, attribute value would be "005").
logoImages array of objects An array of strings identifying the images which include an example logo available for the product. Child object attributes are the same as "images" child object attributes
flavours array of objects [confectionery only] An array of objects identifying the flavours available for the product. flavours.name string An string attached to the object. Often useful for displaying to users. flavours.colourCode string Unique identifier for the colour. flavours.colourBaseCode string Unique identifier for the base colour. e.g. if colour is "light blue", base code will be "blue". This is often used to help with filtering products. flavours.colourName string An arbitrary string attached to the object. Often useful for displaying to users.
dietary object [confectionery only] An array of objects identifying the dietery credentials for the product. dietary.vegetarian boolean Whether or not the product is suitable for a vegetarian. dietary.vegan boolean Whether or not the product is suitable for a vegan. dietary.glutenFree boolean Whether or not the product is gluten free.
specification object An object identifying the specification for the product. specification.shelfLife string [confectionery only] The shelf life of the product. specification.ingredients string [confectionery only] The ingredients of the product. specification.width string Width of product in centimetres. specification.length string Length of product in centimetres. specification.height string Height of product in centimetres. specification.materials array of strings An array of strings to get the materials of the product. specification.weight integer An numeric value of the product weight in grams. specification.batteries array of objects, default is null An array of objects to get the batteries included with the product. specification.batteries.type string Battery type. specification.batteries.quantity integer Battery quantity.
packaging object An object identifying the packaging for the product. packaging.packedPolyBag bool Whether or not the product is individually packaged in a polybag. packaging.packedPieces bool Whether or not the product is individually packaged in a gift box. packaging.cartonInnerQuantity integer Number in inner carton. packaging.palletQuantity integer Number on pallet packaging.exportCarton object An object identifying the export carton for the product. packaging.exportCarton.quantity integer Export carton quantity. packaging.exportCarton.width string Width of the export carton in CM. packaging.exportCarton.length string Length of the export carton in CM. packaging.exportCarton.height string Height of the export carton in CM. packaging.exportCarton.weightNet decimal Net weight of export carton in kilograms. packaging.exportCarton.weightGross decimal Gross weight of the export carton in kilograms.
commodityCode string The commodity code of the product.
origin string The country of origin of the product.
certification array of strings An array of strings to get the certification of the product.
image360 string The URL for accessing the product 360 view widget. Often used in an iframe for displaying to users.
video string The URL for accessing the product video. Often used in an iframe for displaying to users.
expressItem boolean Whether or not the product is offered on our express service.
newItem boolean Whether or not the product is new to our range.
saleItem boolean Whether or not the product is currently on sale.
topSeller boolean Whether or not the product is a best seller in our range.
ecoBasic boolean Whether or not the product is made from 10% – 30% ecological materials.
ecoFriendly boolean Whether or not the product is made from 31% – 60% ecological materials.
ecoFriendly boolean Whether or not the product is made from 61% – 100% ecological materials.
deliveryTime string The guide delivery time of the product. This does not include information about our express items.
keywords array of strings An array of strings populated by us to help identify the product during searches.
dateCreated datetime Timestamp indicating when the product was included in the feed.