2% discount on website orders Blog Saved Microsites Orders Quotes
Final order dates for 2024 Europe Confectionery - 15/11 Europe Branded - 4/12 Europe Plain - 9/12 UK Express Range - 9/12 Final delivery date - Wednesday, 18 December
Extra 5% discount on website orders - use promo code XMAS24 at checkout Valid until - Tuesday, 31 December

Api Documentation - Products V2

All our endpoints are created upon request, so please get in touch to arrange the setup of one.

Authentication

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.

Authentication

Basic Auth

Username your-username
Password your-password

Products

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.

Endpoints

GET https://api.impressioneurope.co.uk/v2/your-endpoint

The default product object

Attributes
sku string
Unique identifier for the product.
url string
The URL for accessing the product on our website.
attributes object
An object containing attributes associated to the product.
attribute.isExpress bool
Whether the product is available on our express service.
attribute.isConfectionery bool
Whether the product is a confectionery item. Attributes marked [confectionery only] will be null and can be ignored if this is false.
attribute.isTubesbool
Whether the product is Tube item. Attributes marked [tubes only] will be null and can be ignored if this is false.
attribute.isNew bool
Whether the product is a new item.
attribute.isBestSeller bool
Whether the product is a best-selling item.
attribute.isEcoBasic bool
Whether the product is made from 10% – 30% ecological materials.
attribute.isEcoFriendly bool
Whether the product is made from 31% – 60% ecological materials.
attribute.isEcoProof bool
Whether the product is made from 61% – 100% ecological materials.
attribute.isSmartSustainable bool
Whether the product is part of our sustainable assortment.
title string
A string often used for displaying to users.
description object
An object containing descriptions for the product.
description.general string
A string often used for displaying to users.
description.information string
A string often used for displaying to users. Usually seperated from the general description with different styling.
description.warning string
A string often used for displaying to users. Usually seperated from the general description with different styling.
restrictions object
An object containing restrictions associated to the product.
restrictions.minimumQuantity int, default 1
The minimum order quantity for the product.
restrictions.quantityIncrements int, default 1
The quantity increment indicates the multiples in which the product must be ordered. For instance, some mugs are packaged in boxes of six, they must be sold as a complete box, so the increment would be set to six.
priceBreaks array of objects
An array of objects containing plain stock pricing for the product.
priceBreaks.quantity int
Price break quantity.
priceBreaks.price decimal
Price break price.
delivery object
An object containing delivery information for the product.
delivery.flatRateThresholds object
An object containing flat rate delivery information based on minimum order values for both branded and unbranded products.
delivery.flatRateThresholds.unbranded object
An object containing unbranded flat rate delivery information.
delivery.flatRateThresholds.unbranded.orderValue decimal
Minimum order value to trigger flat rate.
delivery.flatRateThresholds.unbranded.price decimal
Flat rate price.
delivery.flatRateThresholds.branded object
An object containing branded flat rate delivery information.
delivery.flatRateThresholds.branded.orderValue decimal
Minimum order value to trigger flat rate.
delivery.flatRateThresholds.branded.price decimal
Flat rate price.
delivery.priceBreaks array of objects
An array of objects containing delivery pricing for the product.
delivery.priceBreaks.quantity int
Delivery price break quantity.
delivery.priceBreaks.price decimal
Delivery price break price.
branding object
An object containing branding information for the product.
branding.isMandatory bool
Whether branding is mandatory on the product.
branding.mandatoryPositions int
If branding is mandatory, how many of the positions are mandatory.
branding.options array of objects
An array of objects containing branding options and pricing available on the product.
branding.options.position string
Position of the branding option on the product.
branding.options.method string
Method of the branding option.
branding.options.area string
Area of the branding option in millimeters.
branding.options.isFullColour bool
Whether the branding option is full colour print.
branding.options.maxColours int
Max colours achievable for this branding option. If isFullColour is true, this defaults to 99.
branding.options.restrictions array of objects
An array of objects containing restrictions of this branding option.
branding.options.restrictions.minimumQuantity int
Minimum quantity allowed when ordering with this branding option selected.
branding.options.restrictions.minimumCharge decimal
Minimum charge when ordering with this branding option selected.
branding.options.priceBreaks array of objects
An array of objects containing price breakdown of this branding option.
branding.options.priceBreaks.quantity int
Price break quantity.
branding.options.priceBreaks.price decimal
Price of first colour or full colour print.
branding.options.priceBreaks.priceSubsequent decimal
Price of all subsequent colours if applicable.
branding.options.setup decimal
Price of setup charge (per colour).
branding.options.handling decimal
Price of handling charge (per item).
branding.options.image object
An object containing image information for the branding option.
branding.options.image.src string
Url to access an image showing the branding option area against the product via CDN.
branding.options.image.width int
Dimensions of the image in pixels.
branding.options.image.height int
Dimensions of the image in pixels.
branding.options.image.dateCreated date
Date the image was created.
branding.options.image.dateUpdated date
Date the image was updated.
branding.template string
Url to access a PDF branding template of all branding options against the product via CDN.
colours array of objects
An array of objects containing colour and stock information 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.stock object
An object containing stock information for the product colour.
colours.stock.quantity int
Stock level of product colour.
colours.stock.reserved int
Currently reserved stock level of product colour.
colours.stock.backorders array of objects, default is null
An array of objects containing quantity and delivery date of backorder stock.
colours.stock.backorders.quantity int
Quantity of ordered product colour.
colours.stock.backorders.dateDelivery date
Expected delivery date of backorder.
colours.rgb array of strings
An array of strings representing rgb values of the product's colour. Often useful for displaying to users. A single value indicates a solid color, while multiple values are used to create a linear gradient.
images object
An object containing PNGs & JPGs for the product served from our CDN.
images.pngs array of objects
An array of objects containing PNG image information.
images.pngs.sizes object
An object containing images served at different sizes.
images.pngs.sizes.full string
The URL for accessing the image on our CDN. Where the largest dimension offered is 2000px.
images.pngs.sizes.detail string
The URL for accessing the image on our CDN. Where the largest dimension offered is 800px.
images.pngs.sizes.index string
The URL for accessing the image on our CDN. Where the largest dimension offered is 500px.
images.pngs.sizes.thumb string
The URL for accessing the image on our CDN. Where the largest dimension offered is 200px.
images.pngs.sizesPadded object
An object containing images served at different sizes.
images.pngs.sizesPadded.full string
The URL for accessing the image on our CDN. Where the dimensions offered is 2000 x 2000px.
images.pngs.sizesPadded.detail string
The URL for accessing the image on our CDN. Where the dimensions offered is 800 x 800px.
images.pngs.sizesPadded.index string
The URL for accessing the image on our CDN. Where the dimensions offered is 500 x 500px.
images.pngs.sizesPadded.thumb string
The URL for accessing the image on our CDN. Where the dimensions offered is 200 x 200px.
images.pngs.colourCode string
Mapper to the unique identifier for the product colour displayed in the image.
images.pngs.src string
The URL for accessing the source image on our CDN. This image has not been optimised like the sizes/sizesPadded attributes.
images.pngs.width int
The width of the source image in px.
images.pngs.height int
The height of the source image in px.
images.pngs.dateCreated datetime
Date and time showing when the image was created.
images.pngs.dateUpdated datetime
Date and time showing when the image was last updated.
images.jpgs array of objects
An array of objects containing JPG image information.
images.jpgs.sizes object
An object containing images served at different sizes.
images.jpgs.sizes.full string
The URL for accessing the image on our CDN. Where the largest dimension offered is 2000px.
images.jpgs.sizes.detail string
The URL for accessing the image on our CDN. Where the largest dimension offered is 800px.
images.jpgs.sizes.index string
The URL for accessing the image on our CDN. Where the largest dimension offered is 500px.
images.jpgs.sizes.thumb string
The URL for accessing the image on our CDN. Where the largest dimension offered is 200px.
images.jpgs.sizesPadded object
An object containing images served at different sizes.
images.jpgs.sizesPadded.full string
The URL for accessing the image on our CDN. Where the dimensions offered is 2000 x 2000px.
images.jpgs.sizesPadded.detail string
The URL for accessing the image on our CDN. Where the dimensions offered is 800 x 800px.
images.jpgs.sizesPadded.index string
The URL for accessing the image on our CDN. Where the dimensions offered is 500 x 500px.
images.jpgs.sizesPadded.thumb string
The URL for accessing the image on our CDN. Where the dimensions offered is 200 x 200px.
images.jpgs.colourCode string
Mapper to the unique identifier for the product colour displayed in the image.
images.jpgs.src string
The URL for accessing the source image on our CDN. This image has not been optimised like the sizes/sizesPadded attributes.
images.jpgs.width int
The width of the source image in px.
images.jpgs.height int
The height of the source image in px.
images.jpgs.dateCreated datetime
Date and time showing when the image was created.
images.jpgs.dateUpdated datetime
Date and time showing when the image was last updated.
confectionery object [confectionery only]
An object containing the confectionery information for the product.
confectionery.dietary object
An object containing the dietary credentials for the product.
confectionery.dietary.isVegan boolean
Whether the product is suitable for a vegan.
confectionery.dietary.isVegetarian bool
Whether the product is suitable for a vegetarian.
confectionery.dietary.isGlutenFree bool
Whether the product is gluten-free.
confectionery.shelfLife string
The shelf life of the product.
confectionery.ingredients string
The ingredients of the product.
tubes object [tubes only]
An object containing the tubes information for the product.
tubes.box object
An object containing the box information for the product.
tubes.box.name string
The name of the Tubes box type.
tubes.box.images object
An object containing image information. Formatted the same as the main product image attribute.
tubes.material object
An object containing the tube material information.
tubes.material.name string
The name of the material use for the tube.
tubes.material.description object
Description of the material.
tubes.fillings array of objects
An array of objects containing the filling information of the product.
tubes.fillings.quantity int
The quantity of tubes containing this filling in the product.
tubes.fillings.volumeWeight int
If foodstuff weight in grams, if wine or cocktail volume in ml.
tubes.fillings.foodstuff object
An object containing the foodstuff information.
tubes.fillings.foodstuff.isVegan boolean
Whether the foodstuff filling is suitable for a vegan.
tubes.fillings.foodstuff.isVegetarian bool
Whether the foodstuff filling is suitable for a vegetarian.
tubes.fillings.foodstuff.isGlutenFree bool
Whether the foodstuff filling is gluten-free.
tubes.fillings.foodstuff.name string
The name of the foodstuff filling.
tubes.fillings.foodstuff.description string
Description of the foodstuff filling.
tubes.fillings.foodstuff.images object
An object containing image information. Formatted the same as the main product image attribute.
tubes.fillings.wine object
An object containing the wine information.
tubes.fillings.wine.variety string
The grape variety of the wine filling.
tubes.fillings.wine.winery string
The winery of the wine filling.
tubes.fillings.wine.region string
The region of the wine filling.
tubes.fillings.wine.country string
The country of the wine filling.
tubes.fillings.wine.alcoholContent decimal
The alcohol content percentage of the wine filling.
tubes.fillings.wine.isOrganic boolean
Whether the wine filling is organic.
tubes.fillings.wine.isVegan boolean
Whether the wine filling is suitable for a vegan.
tubes.fillings.wine.isVegetarian bool
Whether the wine filling is suitable for a vegetarian.
tubes.fillings.wine.isGlutenFree bool
Whether the wine filling is gluten-free.
tubes.fillings.wine.name string
The name of the wine filling.
tubes.fillings.wine.description string
Description of the wine filling.
tubes.fillings.wine.images object
An object containing image information. Formatted the same as the main product image attribute.
tubes.fillings.cocktail object
An object containing the cocktail information.
tubes.fillings.cocktail.alcoholContent decimal
The alcohol content percentage of the cocktail filling.
tubes.fillings.cocktail.isVegan boolean
Whether the cocktail filling is suitable for a vegan.
tubes.fillings.cocktail.isVegetarian bool
Whether the cocktail filling is suitable for a vegetarian.
tubes.fillings.cocktail.isGlutenFree bool
Whether the cocktail filling is gluten-free.
tubes.fillings.cocktail.name string
The name of the cocktail filling.
tubes.fillings.cocktail.description string
Description of the cocktail filling.
tubes.fillings.cocktail.images object
An object containing image information. Formatted the same as the main product image attribute.
search object
An object containing the search information for the product.
search.categories array of objects
An array of objects identifying the categories associated to the product.
search.categories.id guid
Unique identifier for the category.
search.categories.parentId bool
Unique identifier for the parent category.
search.categories.name string
Name of the category.
search.categories.url string
Url path of the category.
search.materials array of strings
An array of strings representing searchable material values associated to the product.
search.keywords array of strings
An array of strings populated by us to help identify the product during searches.
specifications object
An object containing the specifications of the product.
specifications.dimensions object
An object containing the dimensions of the product.
specifications.dimensions.diameter decimal
Diameter of the product in millimeters.
specifications.dimensions.height decimal
Height of the product in millimeters.
specifications.dimensions.width decimal
Width of the product in millimeters.
specifications.dimensions.length decimal
Length of the product in millimeters.
specifications.dimensions.depth decimal
Depth of the product in millimeters.
specifications.materials array of strings
An array of strings representing the full list of materials of the product.
specifications.weight decimal
Weight of the product in grams.
specifications.countryOfOrigin string
The country of origin of the product.
specifications.commodityCode string
The commodity code of the product.
specifications.writingColour string
If applicable, the writing colour of the product (ink).
specifications.certificates array of strings
An array of strings representing the certification held against the product.
specifications.batteries array of objects
An array of objects representing the battery types and quantities included with the product.
specifications.batteries.type string
Battery type.
specifications.batteries.quantity int
Battery quantity.
deliveryTime string
The guide delivery time of the product. This does not include information about our express items.
packaging object
An object representing the packaging information of the product.
packaging.palletQuantity int
Quantity of products per pallet.
packaging.innerCarton object
An object containing the information of the inner carton.
packaging.innerCarton.quantity int
Quantity of products in inner carton.
packaging.innerCarton.weight decimal
Weight of inner carton in kilograms.
packaging.innerCarton.dimensions object
An object containing the dimensions of the inner carton.
packaging.innerCarton.dimensions.width decimal
Width of the inner carton in millimeters.
packaging.innerCarton.dimensions.length decimal
Length of the inner carton in millimeters.
packaging.innerCarton.dimensions.height decimal
Height of the inner carton in millimeters.
packaging.outerCarton object
An object containing the information of the outer carton.
packaging.outerCarton.quantity int
Quantity of products in outer carton.
packaging.outerCarton.weight decimal
Weight of outer carton in kilograms.
packaging.outerCarton.dimensions object
An object containing the dimensions of the outer carton.
packaging.outerCarton.dimensions.width decimal
Width of the outer carton in millimeters.
packaging.outerCarton.dimensions.length decimal
Length of the outer carton in millimeters.
packaging.outerCarton.dimensions.height decimal
Height of the outer carton in millimeters.
packaging.isPackedInPolyBag bool
Whether the product is individually packaged in a poly-bag.
packaging.isPackedInGiftBox bool
Whether the product is individually packaged in a gift box.
marketing object
An object representing the marketing information of the product.
marketing.name string
The marketing name we have given the product.
marketing.image360Url string
Url to access a 360-degree viewer showcasing the product
marketing.youtubeUrl string
Url linking to a YouTube video showcasing the product.

The Product Object

{
   "sku": "003076",
   "url": "https://www.impressioneurope.co.uk/soft-feel-notebook-approx-a5/003076/",
   "attributes": {
      "isExpress": true,
      "isConfectionery": false,
      "isTubes": false,
      "isNew": false,
      "isBestSeller": true,
      "isEcoBasic": false,
      "isEcoFriendly": false,
      "isEcoProof": false,
      "isSmartSustainable": false
   },
   "title": "Soft feel notebook (approx. A5)",
   "description": {
      "general": "Introducing the Soft Feel Notebook, the ultimate companion for anyone who loves to…",
      "information": "Approx. A5, 96 lined pages, PU cover, coloured ribbon marker & elastic nylon…",
      "warning": null
   },
   "restrictions": {
      "minimumQuantity": 1,
      "quantityIncrements": 1
   },
   "priceBreaks": [
      {
         "quantity": 1,
         "price": 0.99,
      },
      {
         "quantity": 250,
         "price": 0.88,
      },
      …
   ],
   "delivery": {
      "flatRateThresholds": {
         "unbranded": {
            "orderValue": 100,
            "price": 99
         },
         "branded": {
            "orderValue": 500,
            "price": 99
         }
      },
      "priceBreaks": [
         {
            "quantity": 1,
            "price": 19
         },
         {
            "quantity": 240,
            "price": 29
         },
         …
      ]
   },
   "branding": {
      "isMandatory": false,
      "mandatoryPositions": 0,
      "options": [
         {
            "position": "front",
            "method": "pad",
            "area": "80 x 60",
            "isFullColour": false,
            "maxColours": 3,
            "restrictions": {
               "minimumQuantity": 1,
               "minimumCharge": 20
            },
            "priceBreaks": [
               …
               {
                  "quantity": 250,
                  "price": 0.35,
                  "priceSubsequent": 0.24
               },
               {
                  "quantity": 500,
                  "price": 0.30,
                  "priceSubsequent": 0.19
               },
               …
            ],
            "setup": 99,
            "handling": 0.99,
            "image": {
               "src": "https://cdn.impressioneurope.co.uk/media/a123bc45/3076-front-pad.png",
               "width": 300,
               "height": 500,
               "dateCreated": "2020-01-01T09:30:00.000Z",
               "dateUpdated": "2023-12-20T17:05:00.000Z",
            }
         },
         …
      ],
      "template": "https://cdn.impressioneurope.co.uk/media/1abc23de/3076-branding-template.pdf"
   },
   "colours": [
      {
         "code": "005",
         "baseCode": null,
         "name": "Blue",
         "stock": {
            "quantity": 181679,
            "reserved": 0,
            "backorders": [
               {
                  "quantity": 30000,
                  "dateDelivery": "2023-02-03T00:00:00"
               },
               …
            ]
         },
         "rgb": [
            "32 124 189"
         ]
      },
      {
         "code": "018",
         "baseCode": "005",
         "name": "Light blue",
         "stock": {
            "quantity": 79432,
            "reserved": 0,
            "backorders": null
         },
         "rgb": [
            "98 194 243"
         ]
      },
      …
   ],
   "images": {
      "pngs": [
         {
            "sizes": {
               "full": "https://cdn.impressioneurope.co.uk/media/z987yx6/003076-008999999-2d090-frt…",
               "detail": "https://cdn.impressioneurope.co.uk/media/z987yx6/003076-008999999-2d090-frt…",
               "index": "https://cdn.impressioneurope.co.uk/media/z987yx6/003076-008999999-2d090-frt…",
               "thumb": "https://cdn.impressioneurope.co.uk/media/z987yx6/003076-008999999-2d090-frt…"
            },
            "sizesPadded": {
               "full": "https://cdn.impressioneurope.co.uk/media/z987yx6/003076-008999999-2d090-frt…",
               "detail": "https://cdn.impressioneurope.co.uk/media/z987yx6/003076-008999999-2d090-frt…",
               "index": "https://cdn.impressioneurope.co.uk/media/z987yx6/003076-008999999-2d090-frt…",
               "thumb": "https://cdn.impressioneurope.co.uk/media/z987yx6/003076-008999999-2d090-frt…"
            },
            "colourCode": "008",
            "src": "https://cdn.impressioneurope.co.uk/media/z987yx6/003076-008999999-2d090-frt-pro…",
            "width": 1200,
            "height": 2000,
            "dateCreated": "2022-07-26T10:53:53.117Z",
            "dateUpdated": "2022-07-26T10:56:04.207Z"
         },
         …
      ],
      "jpgs": [
         …
      ],
   },
   "confectionery": {
      "dietary": {
         "isVegan": false,
         "isVegetarian": false,
         "isGlutenFree": false
      },
      "shelfLife": "6-12 months",
      "ingredients": [
         "dextrose",
         …
      ]
   },
   "tubes": {
      "box": {
         "name": "Letterbox",
         "images": {
            "pngs": [
               {
                  "sizes": {
                     "full": "https://cdn.impressioneurope.co.uk/media/z987yx6/xxx…",
                     "detail": "…",
                     "index": "…",
                     "thumb": "…"
                  },
                  "sizesPadded": {
                     "full": "…",
                     "detail": "…",
                     "index": "…",
                     "thumb": "…"
                  },
                  "colourCode": "000",
                  "src": "https://cdn.impressioneurope.co.uk/media/z987yx6/xxx…",
                  "width": 2000,
                  "height": 2000,
                  "dateCreated": "2022-07-26T10:53:53.117Z",
                  "dateUpdated": "2022-07-26T10:56:04.207Z"
               },
               …
            ],
            "jpgs": [
               …
            ],
         }
      },
      "material": {
         "name": "RPET",
         "description": "By opting for RPET tubes…"
      },
      "fillings": [
         {
            "quantity": 1,
            "volumeWeight": 100,
            "foodstuff": {
               "isVegan": false,
               "isVegetarian": false,
               "isGlutenFree": false,
               "name": "Chocolate Truffles (8pc)",
               "description": "Indulge in the delectable experience of savouring these rich dark…",
               "images": {
                  …
               }
            },
            "wine": {
               "variety": "Chardonnay",
               "winery": "Domaine de Rombeau",
               "region": "Côtes Catalanes",
               "country": "France",
               "alcoholContent": 13.5,
               "isOrganic": false,
               "isVegan": false,
               "isVegetarian": false,
               "isGlutenFree": false,
               "name": "",
               "description": "Domaine de Rombeau's Chardonnay presents…",
               "images": {
                  …
               }
            },
            "cocktail": {
               "alcoholContent": 14.9,
               "isOrganic": false,
               "isVegan": false,
               "isVegetarian": false,
               "isGlutenFree": false,
               "name": "Espresso Martini",
               "description": "The Espresso Martini is a cocktail with a double…",
               "images": {
                  …
               }
            }
         },
         …
      ]
   },
   "search": {
      "categories": [
         {
            "id": "00000000-0000-0000-0000-000000000000",
            "parentId": null,
            "name": "Eco",
            "url": "/eco/"
         },
         {
            "id": "11111111-1111-1111-1111-111111111111",
            "parentId": "00000000-0000-0000-0000-000000000000",
            "name": "Eco materials",
            "url": "/eco/materials/"
         },
         {
            "id": "22222222-2222-2222-2222-222222222222",
            "parentId": "11111111-1111-1111-1111-111111111111",
            "name": "Bamboo",
            "url": "/eco/materials/bamboo/"
         },
         …
      ],
      "materials": [
         "Bamboo"
         …
      ],
      "keywords": [
         "PU Cover",
         …
      ]
   },
   "specifications": {
      "dimensions": {
         "diameter": null,
         "height": 15.6,
         "width": 140,
         "length": 210,
         "depth": null
      },
      "materials": [
         "Iron",
         "Bamboo",
         …
      ],
      "weight": 281,
      "countryOfOrigin": "China",
      "commodityCode": "48201030",
      "writingColour": "Blue",
      "certificates": [
         "Cadmium",
         "PAHs",
         …
      ],
      "batteries": [
         {
            "type": "Cell-LR41",
            "quantity": 3
         },
         …
      ],
   },
   "deliveryTime": "10-12 days",
   "packaging": {
      "palletQuantity": 1500,
      "innerCarton": {
         "quantity": 25,
         "weight": 7.25,
         "dimensions": {
            "width": 155,
            "length": 210,
            "height": 110
         }
      },
      "outerCarton": {
         "quantity": 50,
         "weight": 14.64,
         "dimensions": {
            "width": 320,
            "length": 435,
            "height": 240
         }
      },
      "isPackedInPolyBag": true,
      "isPackedInGiftBox": false
   },
   "marketing": {
      "name": "The Braiswick",
      "image360Url": "https://snap360.sirv.com/spins/Impression/3076/3076.spin",
      "youtubeUrl": null
   }
}