2% discount on website orders Blog Saved Microsites Orders Quotes

Api Documentation - Products V1

Deprecated

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/v1/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.
isConfectionery boolean
Whether 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.
categories array of objects
An array of objects to get categories for the product.
category.id guid
Category unique identifier.
category.parentId guid
Category parent unique identifier.
category.name string
Category name.
category.url string
Category url/path.
categoryMain [DEPRECATED] string
The category the product is associated to.
categorySub [DEPRECATED] 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.

The Product Object

{
   "sku": "3076",
   "url": "https://www.impressioneurope.co.uk/notebook-soft-feel-approx-a5/3076/",
   "isConfectionery": false,
   "variant": null,
   "variantText": null,
   "title": "Notebook soft feel (approx. A5)",
   "description": "Soft feel notebook (approx. A5) with a PU cover…",
   "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/"
      },
      
   ],
   "categoryMain": "Stationery & Office",
   "categorySub": "Notebooks",
   "quantityIncrements": 1,
   "printingMandatory": false,
   "printingMandatoryPositions": 0,
   "pricing": [
      {
         "quantity": 50,
         "price": 0.99,
         "delivery": 10.00
      },
      {
         "quantity": 100,
         "price": 0.98,
         "delivery": 11.00
      },
      
   ],
   "printing": [
      {
         "code": "D1",
         "name": "Large digital",
         "image": "https://cdn.impressioneurope.co.uk/media/3076-…",
         "position": "front",
         "method": "digital",
         "max": "full",
         "area": "90 x 90",
         "pricing": [
            {
               "quantity": 50,
               "price": 0.29,
               "extraColourPrice": 0.00
            },
            {
               "quantity": 100,
               "price": 0.28,
               "extraColourPrice": 0.00
            },
            
         ],
         "handling": 0.09,
         "origination": 15.00,
         "originationRepeat": 10.00
      },
      {
         "code": "P2",
         "name": "Medium pad",
         "image": "https://cdn.impressioneurope.co.uk/media/3076-…",
         "position": "front,
         "method": "pad",
         "max": "4",
         "area": "100 x 100"
         "pricing": [
            {
               "quantity": 50,
               "price": 0.19,
               "extraColourPrice": 0.09
            },
            {
               "quantity": 100,
               "price": 0.18,
               "extraColourPrice": 0.08
            },
            
         ],
         "handling": 0.00,
         "origination": 10.00,
         "originationRepeat": 5.00
      },
      
   ],
   "colours": [
      {
         "code": "005",
         "baseCode": null,
         "name": "Blue",
         "size": "One size",
         "stock": 282918,
         "reserved": 0,
         "backOrders": null
      },
      {
         "code": "018",
         "baseCode": "005",
         "name": "Light blue",
         "size": "One size",
         "stock": 53546,
         "reserved": 1234,
         "backOrders": [
            {
               "quantity": 90000,
               "deliveryDate": "2022-05-06T00:00:00",
            },
            
         ]
      },
      
   ],
   "sizes": null,
   "images": [
      {
         "srcFull": "https://cdn.impressioneurope.co.uk/media/3076-005…",
         "srcDetail": "https://cdn.impressioneurope.co.uk/media/3076-005…",
         "srcIndex": "https://cdn.impressioneurope.co.uk/media/3076-005…",
         "srcThumb": "https://cdn.impressioneurope.co.uk/media/3076-005…",
         "colourCode": "005",
         "flavourColourCode": null
      }
      {
         "srcFull": "https://cdn.impressioneurope.co.uk/media/3076-018…",
         "srcDetail": "https://cdn.impressioneurope.co.uk/media/3076-018…",
         "srcIndex": "https://cdn.impressioneurope.co.uk/media/3076-018…",
         "srcThumb": "https://cdn.impressioneurope.co.uk/media/3076-018…",
         "colourCode": "018",
         "flavourColourCode": null
      },
      
   ],
   "logoImages": null,
   "flavours": [
      {
         "name": "Sugar free mints",
         "colourCode": "002",
         "colourBaseCode": null,
         "colourName": "White"
      },
      
   ],
   "dietary": {
      "vegetarian": true,
      "vegan": false,
      "glutenFree": true
   },
   "specification": {
      "shelfLife": "6-12 months",
      "ingredients": "Sorbitol 97 - 95%, Aspartame & Acesulfame K 0 - 45%, Peppermint 1 - 3%…",
      "width": "14.2",
      "length": "21.2",
      "height": "1.5",
      "materials": [
         "Cardboard",
         "Paper",
         "PU"
      ],
      "weight": 285,
      "batteries": [
         {
            "type": "Cell-LR41",
            "quantity": 4
         },
         
      ]
   },
   "packaging": {
      "packedPolyBag": true,
      "packedPieces": true,
      "cartonInnerQuantity": 50,
      "palletQuantity": 10400,
      "exportCaton": {
         "quantity": 200,
         "width": "24.4",
         "length": "31.5",
         "height": "25",
         "weightNet": 8.4,
         "weightGross": 8.91
      }
   },
   "commodityCode": "12340000",
   "origin": "United Kingdom",
   "certification": [
      "Battery 2006/66/EC",
      "PAHs",
      "RoHS",
      "D.o.C EMC/CE",
      "EMC",
      "MSDS",
      "BSCI"
   ],
   "image360": "https://snap360.sirv.com/spins/Impression/3117/3117.spin",
   "video": null,
   "expressItem": true,
   "newItem": false,
   "saleItem": false,
   "topSeller": false,
   "ecoBasic": false,
   "ecoFriendly": false,
   "ecoProof": false,
   "deliveryTime": "2-3 weeks",
   "keywords": [
      "Something",
      "To",
      "Help",
      "Searches"
   ],
   "dateCreated": "2022-01-01T09:30:00"
}