/v4/products

Provides product information

GET

For a listing of products and prices.

Optional URL Parameters:

(Search Filters)

parameter arguments info
search Auto search string, searches product code, barcode, or description
temperature 'A', 'C', 'F' Ambient, Chilled, Frozen, respectively
group The product group to filter to e.g. 1.09.73.7320, or 1.09, or 1
productCodes Comma seperated string, or an array
barcodes Comma seperated string, or an array
promotion If set to anything then shows only promotion products
flag Comma seperated string
priceMarked 'true', 'false' If not supplied then will show all, if set to 'true' then will show only priceMarked products, if set to 'false' then won't show any pricemarked products
brand

e.g. /products/?division=DIVISION&username=USERNAME&group=1&search=cake

(Pagination - Please use these when making large/unfiltered requests)

parameter info
page Pages start from 1
limit Number of results to show per page

e.g. /products/?division=DIVISION&username=USERNAME&page=3&limit=1000

Note #1: Total number of products for the current selection criteria regardless of limit is returned in the header "afb-total-products"

Note #2: There are rare circumstances where a page may return less results that expected due to a filter late in the process, the header count will still be counting those missing products and so will accurately represent how many pages remain to be returned.

Example 1:

Retrieving user's full product listing.

This will show the user's product range and prices.

Authentication is required.

URL:

/products/?division=DIVISION&username=USERNAME

Example JSON Response
[
    {
        "productCode": "300105",
        "defaultSortOrder": 0,
        "division": "CC",
        "title": "\"Tom Smith 6 x 12\"\" Celebrations Crackers\"",
        "quantity": 6,
        "size": "6 x 6pce",
        "comGroup": 7320,
        "parent": true,
        "departments": [
            "1",
            "09",
            "73",
            "7320"
        ],
        "category": "1.09.73.7320",
        "parentCode": "300105",
        "childCodes": [
            "300105"
        ],
        "priceMarked": false,
        "temperature": "A",
        "maxQuantity": 50,
        "splits": [],
        "case": null,
        "barcodes": [
            "5012213418928",
            "5012213518130",
            "300105"
        ],
        "ean": [
            "5012213418928"
        ],
        "tuc": [
            "5012213518130"
        ],
        "otu": [],
        "uan": [],
        "unavailableReason": "Volume restrictions of 2 cases are in place to maximise availability to all customers until further notice",
        "reasonableOrderLimit": 2,
        "allowPurchase": true,
        "keywords": [],
        "flags": [],
        "images": {
            "medium": "https://www.afblakemore.net/content/product_image_loader.php?product_code=300105&division=CC&size=M",
            "large": "https://www.afblakemore.net/content/product_image_loader.php?product_code=300105&division=CC&size=L"
        },
        "html": "https://www.afblakemore.net/products/info/app.php?p_code=300105&division=CC",
        "pricing": {
            "wsp": "1.23",
            "rrp": "7.99",
            "por": "123.45",
            "vatRate": "20.00",
            "promotion": false,
            "promotionDate": null,
            "originalWsp": null
        },
        "minLifeDays": 0
    },
    {
        "productCode": "300116",
        "defaultSortOrder": 0,
        "division": "CC",
        "title": "\"Tom Smith 6 x 12\"\" Gold & Cream Crackers\"",
        "quantity": 12,
        "size": "12 x 6pce",
        "comGroup": 7320,
        "parent": true,
        "departments": [
            "1",
            "09",
            "73",
            "7320"
        ],
        "category": "1.09.73.7320",
        "parentCode": "300116",
        "childCodes": [
            "300116"
        ],
        "priceMarked": false,
        "temperature": "A",
        "maxQuantity": 50,
        "splits": [],
        "case": null,
        "barcodes": [
            "5012213417792",
            "5012213517935",
            "300116"
        ],
        "ean": [
            "5012213417792"
        ],
        "tuc": [
            "5012213517935"
        ],
        "otu": [],
        "uan": [],
        "unavailableReason": "Volume restrictions of 2 cases are in place to maximise availability to all customers until further notice",
        "reasonableOrderLimit": 2,
        "allowPurchase": true,
        "keywords": [],
        "flags": [],
        "images": {
            "medium": "https://www.afblakemore.net/content/product_image_loader.php?product_code=300116&division=CC&size=M",
            "large": "https://www.afblakemore.net/content/product_image_loader.php?product_code=300116&division=CC&size=L"
        },
        "html": "https://www.afblakemore.net/products/info/app.php?p_code=300116&division=CC",
        "pricing": {
            "wsp": "2.34",
            "rrp": "7.99",
            "por": "135.79",
            "vatRate": "20.00",
            "promotion": false,
            "promotionDate": null,
            "originalWsp": null
        },
        "minLifeDays": 0
    }
]

    

Example 2:

Retrieving full generic product listing - this is not available for all divisions.

Prices will not be shown for genetic product listings.

Authentication is not required.

URL:

/products/?division=DIVISION

Example JSON Response
[
    {
        "productCode": "300105",
        "defaultSortOrder": 0,
        "division": "CC",
        "title": "\"Tom Smith 6 x 12\"\" Celebrations Crackers\"",
        "quantity": 6,
        "size": "6 x 6pce",
        "comGroup": 7320,
        "parent": true,
        "departments": [
            "1",
            "09",
            "73",
            "7320"
        ],
        "category": "1.09.73.7320",
        "parentCode": "300105",
        "childCodes": [
            "300105"
        ],
        "priceMarked": false,
        "temperature": "A",
        "maxQuantity": 50,
        "splits": [],
        "case": null,
        "barcodes": [
            "5012213418928",
            "5012213518130",
            "300105"
        ],
        "ean": [
            "5012213418928"
        ],
        "tuc": [
            "5012213518130"
        ],
        "otu": [],
        "uan": [],
        "unavailableReason": "Volume restrictions of 2 cases are in place to maximise availability to all customers until further notice",
        "reasonableOrderLimit": 2,
        "allowPurchase": true,
        "keywords": [],
        "flags": [],
        "images": {
            "medium": "https://www.afblakemore.net/content/product_image_loader.php?product_code=300105&division=CC&size=M",
            "large": "https://www.afblakemore.net/content/product_image_loader.php?product_code=300105&division=CC&size=L"
        },
        "html": "https://www.afblakemore.net/products/info/app.php?p_code=300105&division=CC",
        "pricing": {
            "wsp": null,
            "rrp": "7.99",
            "por": null,
            "vatRate": "20.00",
            "promotion": false,
            "promotionDate": null,
            "originalWsp": null
        },
        "minLifeDays": 0
    },
    {
        "productCode": "300116",
        "defaultSortOrder": 0,
        "division": "CC",
        "title": "\"Tom Smith 6 x 12\"\" Gold & Cream Crackers\"",
        "quantity": 12,
        "size": "12 x 6pce",
        "comGroup": 7320,
        "parent": true,
        "departments": [
            "1",
            "09",
            "73",
            "7320"
        ],
        "category": "1.09.73.7320",
        "parentCode": "300116",
        "childCodes": [
            "300116"
        ],
        "priceMarked": false,
        "temperature": "A",
        "maxQuantity": 50,
        "splits": [],
        "case": null,
        "barcodes": [
            "5012213417792",
            "5012213517935",
            "300116"
        ],
        "ean": [
            "5012213417792"
        ],
        "tuc": [
            "5012213517935"
        ],
        "otu": [],
        "uan": [],
        "unavailableReason": "Volume restrictions of 2 cases are in place to maximise availability to all customers until further notice",
        "reasonableOrderLimit": 2,
        "allowPurchase": true,
        "keywords": [],
        "flags": [],
        "images": {
            "medium": "https://www.afblakemore.net/content/product_image_loader.php?product_code=300116&division=CC&size=M",
            "large": "https://www.afblakemore.net/content/product_image_loader.php?product_code=300116&division=CC&size=L"
        },
        "html": "https://www.afblakemore.net/products/info/app.php?p_code=300116&division=CC",
        "pricing": {
            "wsp": null,
            "rrp": "7.99",
            "por": null,
            "vatRate": "20.00",
            "promotion": false,
            "promotionDate": null,
            "originalWsp": null
        },
        "minLifeDays": 0
    }
]