Data API Guidance
Ready and working? This email address is being protected from spambots. You need JavaScript enabled to view it. For API integration
ProCart Supplier API Guidance
Built by developers for developers. This is a quick guide to the best practices when producing an API and what is required as a standard for product information.
This email address is being protected from spambots. You need JavaScript enabled to view it.
API Guidance Documentation
Please view this page on a desktop
Security of the end point
For security, we highly recommend authentication to access the endpoint, otherwise, this leaves the prices of customers available to the public.
Security - Simple Authentication
Username assinged-username
Password assinged-password
Serving Products Per Block
For helping with future filtering to offer pagination and making it easier to identify each product, if a single block could contain all product information product, this offers easier reading for systems like ours that have to manage the reading of the files to then convert into a new format.
Example Explanation -
Please see quick example of using "per block" for products.
This is not all the information required!
#Main List
The above comment is the overall container for the products and opens and closes around the entire file. Here comments such as Copy right, intended client name or last update date/time could be placed, but this is optional.
#Product
The above comment is used to show the opening of a block for a single product, this will hold all the information against the listed SKU.
For multi indented information, see below examples for colours and print.
JSON/XML Object Setup (Snipped Example)
{ #Opening Main List
{ #Opening Product
"sku": "product-sku-code",
"url": "https://www.promonet.co.uk/product/sku",
"main-image": "https://www.promonet.co.uk/images/product/sku.png",
"title": "product-name",
"description": "product-description",
"category": "product-category",
"delivery": [
{
"quantity": NUM,
"price": NUM,
},
{
"quantity": NUM,
"price": NUM,
>
}
]
} #Closing Product
{ #Opening Next Product
...
} #Closing Next Product
} #Closing Main List
Listing Colours
This can be different for each setup, but please see our example of using an array for colours and what we found was easy to interpret for data sorting and for downloading to our CDN.
The image can be served within the "colours" block, or a separate image section could be set up referencing the colour code, but here the foundation is now set up for any additional information. Stock could be listed within the section or additional prices for certain colours.
Colour Array Setup (Snipped Example)
{ #Opening Main List
{ #Opening Product
...
"colours": [
{
"colour": "colour-name",
"code": "colour-code",
"colImage": "www.promonet.co.uk/images/product/sku_colour.png",
},
{
"colour": "colour-name",
"code": "colour-code",
"colImage": "www.promonet.co.uk/images/product/sku_colour.png",
}
]
} #Closing Product
} #Closing Main List
Print Price Setup
For print prices, if displayed in multiple arrays like the example, multiple prices can be displayed within the main section "print". Assigning a print code here will also allow for reference for extra information again.
#Print Array
This is the beginning where all information regarding all printing methods can be placed.
#Price Array
"Pricing" is associated with the print method it's embedded to, allowing for the quantity breaks to be placed with their prices. Then the next input can have a new printing method and assign the prices and quantities that are relevant.
Print Prices Array Setup (Snipped Example)
{ #Opening Main List
{ #Opening Product
...
"print": [ #Opening Print Array
{
"printCode": "printing-code",
"printName": "print-name",
"printMethod": "printing-methed",
"printImage": "print-image-url",
"printPosition": "printing-position",
"printArea": "printing-area",
"pricing": [ #Opening Price Array
{
"quantity": quantity-amount,
"price": quantity-unit-price,
},
{
"quantity": quantity-amount,
"price": quantity-unit-price,
},
...
], #Closing Price Array
"origination": "print-origination",
},
], #Closing Print Array
...
} #Closing Product
} #Closing Main List
Required Fields For Our System
Coming soon...
