api.html

<!DOCTYPE html>
<html lang="en-gb">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>REC+ API</title>
    <meta name="description" content="REC+ API quick guide, taking you through set up and usage of the API.">

    <link rel="dns-prefetch" href="https://cdnjs.cloudflare.com">
    <link rel="preconnect" href="https://cdnjs.cloudflare.com/">

    <link rel="dns-prefetch" href="https://fonts.googleapis.com">
    <link rel="dns-prefetch" href="https://fonts.gstatic.com">
    <link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>

    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
    <link rel="manifest" href="/site.webmanifest">

    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.1/normalize.min.css">
    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Poppins:400,700">
    <link rel="stylesheet" href="/css/api.css?v7">
</head>
<body>

    <header class="page-header">
        <h1>
            REC+ API
            <span>
                <svg xmlns="http://www.w3.org/2000/svg" height="1em" viewBox="0 0 640 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2023 Fonticons, Inc. --><path d="M64 96c0-35.3 28.7-64 64-64H512c35.3 0 64 28.7 64 64V352H512V96H128V352H64V96zM0 403.2C0 392.6 8.6 384 19.2 384H620.8c10.6 0 19.2 8.6 19.2 19.2c0 42.4-34.4 76.8-76.8 76.8H76.8C34.4 480 0 445.6 0 403.2zM281 209l-31 31 31 31c9.4 9.4 9.4 24.6 0 33.9s-24.6 9.4-33.9 0l-48-48c-9.4-9.4-9.4-24.6 0-33.9l48-48c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9zM393 175l48 48c9.4 9.4 9.4 24.6 0 33.9l-48 48c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l31-31-31-31c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0z"/></svg>
                Quick Guide
            </span>
        </h1>
    </header>

    <div class="page-wrapper">

        <nav class="page-sidebar">
            <ul>
                <li>
                    <strong>Contents</strong>
                </li>
                <li>
                    <a href="#introduction">Introduction</a>
                </li>
                <li>
                    <a href="#api-accounts">API Accounts</a>
                </li>
                <li>
                    <a href="#auth-scopes">Auth & Scopes</a>
                </li>
                <li>
                    <a class="toggle-sub-links" href="#"></a>
                    <a href="#request-examples">Request Examples</a>
                    <ul>
                        <li><a href="#request-examples--curl">curl</a></li>
                        <li><a href="#request-examples--php">PHP</a></li>
                    </ul>
                </li>
                <li>
                    <a class="toggle-sub-links" href="#"></a>
                    <a href="#responses">Response Examples</a>
                    <ul>
                        <li><a href="#responses">Products collection</a></li>
                        <li><a href="#responses--product">Product</a></li>
                        <li><a href="#responses--error">Error</a></li>
                        <li><a href="#responses--order">Order</a></li>
                    </ul>
                </li>
                <li>
                    <a class="toggle-sub-links" href="#"></a>
                    <a href="#resources">Resources</a>
                    <ul>
                        <li><a href="#resources--blog-posts">Blog Posts</a></li>
                        <li><a href="#resources--categories">Categories</a></li>
                        <li><a href="#resources--coupons">Coupons</a></li>
                        <li><a href="#resources--delivery-methods">Delivery Methods</a></li>
                        <li><a href="#resources--departments">Departments</a></li>
                        <li><a href="#resources--downloads">Downloads</a></li>
                        <li><a href="#resources--download-categories">Download categories</a></li>
                        <li><a href="#resources--gallery">Gallery</a></li>
                        <li><a href="#resources--google-reviews">Google Reviews</a></li>
                        <li><a href="#resources--manufacturers">Manufacturers</a></li>
                        <li><a href="#resources--newsletters">Newsletters</a></li>
                        <li><a href="#resources--options">Options</a></li>
                        <li><a href="#resources--orders">Orders</a></li>
                        <li><a href="#resources--pages">Pages</a></li>
                        <li><a href="#resources--payment-methods">Payment Methods</a></li>
                        <li><a href="#resources--product-filter-blocks">Product Filter Blocks</a></li>
                        <li><a href="#resources--product-reviews">Product Reviews</a></li>
                        <li><a href="#resources--products">Products</a></li>
                        <li><a href="#resources--regions">Regions</a></li>
                        <li><a href="#resources--sliders">Sliders</a></li>
                        <li><a href="#resources--stock">Stock</a></li>
                        <li><a href="#resources--testimonials">Testimonials</a></li>
                        <li><a href="#resources--user-groups">User Groups</a></li>
                        <li><a href="#resources--userfiles">Userfiles</a></li>
                        <li><a href="#resources--users">Users</a></li>
                        <li><a href="#resources--vat-types">VAT Types</a></li>
                    </ul>
                </li>
                <li>
                    <a href="#api-webhooks">API Webhooks</a>
                </li>
                <li>
                    <a href="#api-explorer">API Explorer</a>
                </li>
                <li>
                    <a href="#further-reading">Further Reading</a>
                </li>
            </ul>
        </nav>

        <main class="page-main">

            <section class="doc-section">
                <header>
                    <h2 id="introduction">Introduction</h2>
                </header>

                <p>REC+ sites have a RESTful API available to lookup or modify data.
                    They also support webhooks which can send API objects to you on specific events such as <code>new.order</code>.</p>

            </section>

            <section class="doc-section">
                <header>
                    <h2 id="api-accounts">API Accounts</h2>
                </header>

                <p>Set up or request API Access via admin.</p>

                <p>To set up an account when logged in to the Admin area, open API Accounts on the sidebar.
                    <br>Set your account details and the scopes you need access to.</p>

                <p>You will then be provided both a Public API key & Full API Access (limited by scopes) via <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication">HTTP Basic Auth</a> over HTTPS/TLS.</p>

                <p>Manage or view the logs of your API account any time via the same API Access area in Admin.</p>

                <p>
                    <img src="/images/api/api-accounts.png" alt="API Accounts View">
                </p>
            </section>

            <section class="doc-section">
                <header>
                    <h2 id="auth-scopes">Auth & Scopes</h2>
                </header>

                <p>Public key access only gives you access to public data, such as product listings. It does not allow access to private store data such as orders, nor does it allow you to make any modifications.</p>

                <p>To access (& modify) everything allowed by your scopes, you&apos;ll need to use <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication">HTTP Basic Auth</a> over HTTPS with the Full API username & password. </p>

                <p>Scopes limit the access your account has, such as if your app only needs access to Orders, you can limit your scope to only Orders. </p>

                <p>Currently available scopes:
                    <br><code>store_content</code> - Manages the products, categories, etc.
                    <br><code>content</code> - Manages the downloads, blog_items, pages, etc.
                    <br><code>users</code> - Manages the users, user groups, etc.)
                    <br><code>orders</code> - Manages the orders, payment methods, delivery, etc.
                </p>
            </section>

            <section class="doc-section">
                <header>
                    <h2 id="request-examples">Request Examples</h2>
                </header>

                <p>
                    <small>Replace {DOMAIN} with the website domain name, as well as {API_USER} & {API_PASS} with your assigned API username & password.</small>
                </p>

                <h3 id="request-examples--curl">Curl</h3>

                <pre><code class="language-bash hljs"># Lookup all products
curl "https://{DOMAIN}/api/v1/products" --user {API_USER}:{API_PASS}

# Lookup specific product by code
curl "https://{DOMAIN}/api/v1/products/test?identifier=code" --user {API_USER}:{API_PASS}

# Update specific product by code
curl -X POST -d @data.json "https://{DOMAIN}/api/v1/products/test?identifier=code" --user {API_USER}:{API_PASS}

# Batch update products
curl -X POST -d @data.json "https://{DOMAIN}/api/v1/products" --user {API_USER}:{API_PASS}
</code></pre>

                <h3 id="request-examples--php">PHP</h3>

                <pre><code class="language-php hljs">class REC
{
    protected static string $api_user = '{API_USER}';
    protected static string $api_pass = '{API_PASS}';
    protected static string $base = 'https://{DOMAIN}';

    public static function api(string $method, string $resource, ?array $data = null): object
    {
        $ch = curl_init(static::$base . '/api/v1' . $resource);
        curl_setopt($ch, CURLOPT_USERPWD, static::$api_user . ':' . static::$api_pass);
        curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        $method = strtoupper($method);
        if ($method === 'POST') {
            curl_setopt($ch, CURLOPT_POST, true);
            curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data, JSON_THROW_ON_ERROR));
            curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
        } elseif ($method !== 'GET') {
            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
        }
        $response = curl_exec($ch);
        $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);

        return (object) [
            'status' => $status,
            'response' => $response ? json_decode($response, false, 512, JSON_THROW_ON_ERROR) : null,
        ];
    }
}
</code></pre>

                <pre><code class="language-php hljs">// Lookup all products
$products = REC::api('GET', '/products');

// Lookup specific product by code
$productCode = 'test';
$product = REC::api('GET', '/products/' . $productCode . '?identifier=code');

// Create new product
$product = REC::api('POST', '/products', [
    'products' => [[
        'code' => 'test',
        'name' => 'Test Product',
    ]],
]);

// Update specific product by code
$product = REC::api('POST', '/products/' . $productCode . '?identifier=code', [
    'name' => 'Test Product UPDATED',
]);

// Batch update products
$products = REC::api('POST', '/products?identifier=code', [
    'products' => [
        [
            'code' => 'test',
            'name' => 'Test Product',
        ],
        [
            'code' => 'test2', // or this will insert/create if code not found
            'name' => 'Test Product 2',
        ],
    ],
]);

// Delete specific product by code
$product = REC::api('DELETE', '/products/' . $productCode . '?identifier=code');

// Batch delete products
$products = REC::api('DELETE', '/products?identifier=code&ids=' . implode(',', [
    'test',
    'test2',
]));
</code></pre>

                <p>HTTP methods indicate the type of request, e.g. to lookup a collection of objects or a specific object use <code>GET</code>. Creating or updating an object uses <code>POST</code> <small>(<code>PATCH</code> also supported for updates but is treated the same as <code>POST</code>, both support partial updates)</small>. To remove/delete a resource use <code>DELETE</code>. Batch creates, updates & deletes are also supported.</p>

            </section>

            <section class="doc-section">
                <header>
                    <h2 id="responses">Response Examples</h2>
                </header>

                <p>By default the API returns JSON responses however it can also return XML if needed.</p>

                <p>Use Admin > <a href="#api-explorer">API Explorer</a> to view live example responses on the site.</p>

                <p>All products example JSON:</p>
                <pre><code class="language-json hljs">{
    "href": "\/products.json?fields=&identifier=",
    "products": [
        {
            "href": "\/products\/58663.json",
            "id": 58663,
            "name": "HOT SAUCE GIFT VOUCHER",
            "code": "Sauce-gift-voucher",
            "status": "live",
            "link": "http:\/\/rec.localhost\/HOT_SAUCE_GIFT_VOUCHER--product--58663.html",
            "image": "http:\/\/rec.localhost\/userfiles\/images\/sys\/products\/HOT_SAUCE_GIFT_VOUCHER_67999_0.jpg",
            "price": {
                "normal": "400.00",
                "special_offer": "0.00"
            }
        },
        {
            "href": "\/products\/58662.json",
            "id": 58662,
            "name": "Tubby Tom&#039;s The Squealer Hot Sauce 150g",
            "code": "Sauce-997706",
            "status": "live",
            "link": "http:\/\/rec.localhost\/Tubby_Tom039s_The_Squealer_Hot_Sauce_150g--product--58662.html",
            "image": "http:\/\/rec.localhost\/userfiles\/images\/sys\/products\/Tubby_Toms_The_Squealer_Hot_Sauce_150g_12652_0.jpg",
            "price": {
                "normal": "8.40",
                "special_offer": "0.00"
            }
        },
        {
            "href": "\/products\/58661.json",
            "id": 58661,
            "name": "Traeger Texas Spicy BBQ Sauce 16oz",
            "code": "Sauce-1105410",
            "status": "live",
            "link": "http:\/\/rec.localhost\/Traeger_Texas_Spicy_BBQ_Sauce_16oz--product--58661.html",
            "image": "http:\/\/rec.localhost\/userfiles\/images\/sys\/products\/Traeger_Texas_Spicy_BBQ_Sauce_16oz_70879jpeg.jpg",
            "price": {
                "normal": "132.00",
                "special_offer": "0.00"
            }
        }
    ],
    "count": 25,
    "total_count": 83,
    "paging": {
        "offset": 0,
        "limit": 25,
        "first_page_href": "\/products.json?fields=&identifier=&limit=25&offset=0",
        "last_page_href": "\/products.json?fields=&identifier=&limit=25&offset=75",
        "next_page_href": "\/products.json?fields=&identifier=&limit=25&offset=25",
        "previous_page_href": null
    }
}
</code></pre>

                <p id="responses--product">Specific product example JSON:</p>
                <pre><code class="language-json hljs">{
    "href": "\/products\/58661.json",
    "id": 58661,
    "name": "Traeger Texas Spicy BBQ Sauce 16oz",
    "code": "Sauce-1105410",
    "status": "live",
    "link": "http:\/\/rec.localhost\/Traeger_Texas_Spicy_BBQ_Sauce_16oz--product--58661.html",
    "image": "http:\/\/rec.localhost\/userfiles\/images\/sys\/products\/Traeger_Texas_Spicy_BBQ_Sauce_16oz_70879jpeg.jpg",
    "price": {
        "normal": "132.00",
        "special_offer": "0.00"
    },
    "additional_images": [

    ],
    "short_desc": "",
    "desc": "&lt;p>&nbsp;&lt;\/p&gt;\n\n&lt;p&gt;&lt;strong&gt;Why we love it:&lt;\/strong&gt;&lt;\/p&gt;\n\n&lt;p&gt;Features peppery heat that&rsquo;s awesome with wings or pulled pork, and its thinner consistency makes it a great choice for marinating, too.&lt;\/p&gt;\n\n&lt;p&gt;Spicy, peppery sauce with that works as marinade or sauce&lt;\/p&gt;\n\n&lt;p&gt;Great on everything from chicken and pork to beef&lt;\/p&gt;\n\n&lt;p&gt;&lt;br \/&gt;\n&lt;strong&gt;What you need to know:&lt;\/strong&gt;&lt;\/p&gt;\n\n&lt;p&gt;1 x Traeger Texas Spicy BBQ Sauce 16oz&lt;\/p&gt;\n\n&lt;p&gt;Size: 16oz \/ 473ml&lt;\/p&gt;\n",
    "tax_class": 1,
    "additional_prices": [

    ],
    "categories": {
        "default": {
            "href": "\/categories\/24001.json",
            "id": 24001
        },
        "2": null,
        "3": null,
        "4": null,
        "5": null
    },
    "date_added": "2023-07-25T17:31:44",
    "date_modified_admin": "2023-07-25T18:07:10",
    "date_modified_api": null,
    "sort_order": 0,
    "custom_sort_order": {
        "featured": 0,
        "special": 0
    },
    "delivery": {
        "costs_to_zones": [

        ],
        "free_delivery": 0,
        "free_delivery_zone": 0
    },
    "manufacturer": null,
    "stock": {
        "qty": 1980,
        "options_group_use_as_stock": "",
        "pack_qty": 1,
        "alert_qty": "",
        "stop_qty": "",
        "back_in_stock_date": ""
    },
    "marketing_site_link": "",
    "hide_prices": false,
    "is_enquiry_only": false,
    "banner_text": "",
    "banner_color": "#",
    "model_3d_image_path": "",
    "model_3d_image_path_ios": "",
    "download": null,
    "additional_downloads": [

    ],
    "options": [
        {
            "id": 12347,
            "group": "Multi Pack",
            "desc": "Yes",
            "code": "",
            "price": "4.20",
            "special_price": "",
            "weight": "",
            "stock_qty": 981,
            "sort_order": 1,
            "hidden": false,
            "gtin": "",
            "cost": "",
            "sync_key": "RGe0x2",
            "group_prices": {

            },
            "group_special_prices": {

            }
        },
        {
            "id": 12348,
            "group": "Multi Pack",
            "desc": "No",
            "code": "",
            "price": "0.00",
            "special_price": "",
            "weight": "",
            "stock_qty": 999,
            "sort_order": 2,
            "hidden": false,
            "gtin": "",
            "cost": "",
            "sync_key": "Rr09B2",
            "group_prices": {

            },
            "group_special_prices": {

            }
        },
        {
            "id": 12349,
            "group": "Saver Discount",
            "desc": "Yes",
            "code": "",
            "price": "1.20",
            "special_price": "",
            "weight": "",
            "stock_qty": 1980,
            "sort_order": 3,
            "hidden": false,
            "gtin": "",
            "cost": "",
            "sync_key": "E49NjR",
            "group_prices": {

            },
            "group_special_prices": {

            }
        }
    ],
    "attributes": [

    ],
    "weight": "",
    "youtube_clip": "",
    "videos": [

    ],
    "cost_price": "",
    "is_digital": false,
    "is_addon_product": false,
    "is_discontinued": false,
    "exclude_from_api_webhook": false,
    "triggers_event_system": true,
    "special_offer_start_date": null,
    "special_offer_end_date": null,
    "meta_title": "",
    "meta_keywords": "",
    "meta_description": "",
    "exclude_from_google_base": false,
    "google_product_category": "",
    "purchase_event": null,
    "bundle": {
        "sync_stock_with_components": false,
        "sync_price_with_components": false,
        "sync_cost_with_components": false,
        "sync_weight_with_components": false,
        "is_bundle": false,
        "assembly_instructions": "",
        "assembly_bin_location": ""
    },
    "launch_date": "0000-00-00 00:00:00",
    "launch_status": "live",
    "packaging_type_id": 1,
    "tags": {
        "Design": [

        ],
        "Warnings": [

        ],
        "Colours": [

        ],
        "Season": [

        ],
        "Product Ranges": [

        ],
        "No products match this group": [

        ],
        "Forge Example": [

        ]
    },
    "associations": [

    ],
    "alternatives": [

    ],
    "addons": [

    ],
    "components": [

    ],
    "variations": [
        {
            "code": "Sauce-1105410-yes-yes",
            "prev_codes": "",
            "stock": 981,
            "cost": "",
            "options": {
                "Multi Pack": "Yes",
                "Saver Discount": "Yes"
            }
        },
        {
            "code": "Sauce-1105410-no-yes",
            "prev_codes": "",
            "stock": 999,
            "cost": "",
            "options": {
                "Multi Pack": "No",
                "Saver Discount": "Yes"
            }
        }
    ]
}</code></pre>

                <p id="responses--error">Example error response: <small>HTTP status also reflects the error status</small></p>
                <pre><code class="language-json hljs">{
    "errors": [
        {
            "status": 404,
            "message": "Product not found"
        }
    ]
}</code></pre>

                <p id="responses--order">Specific order example JSON:</p>
                <pre><code class="language-json hljs">{
    "href": "\/orders\/112312.json",
    "id": 112312,
    "invoice_id": 825,
    "session_id": "s.64bf9a63f18ea5.12594747",
    "start_date": "2023-07-26T00:03:07",
    "payment_date": "2023-07-26T00:03:59",
    "payment_method": {
        "href": "\/payment-methods\/58.json",
        "id": 58,
        "name": "PayPal Express Checkout"
    },
    "payment_data": {
        "verify_sign": "",
        "payer_id": "",
        "payer_status": ""
    },
    "status": "Payment Received",
    "user": {
        "href": "\/users\/123.json",
        "id": 123,
        "full_name": "Bob Smith",
        "membership_code": "",
        "email": "bob@smithnet.co.uk",
        "billing_address": {
            "recipient_name": "Bob Smith",
            "business_name": "",
            "line_1": "12 Fake Street",
            "line_2": "",
            "town": "Worcester",
            "region": {
                "href": "\/regions\/244.json",
                "country": "United States",
                "county": "Alabama"
            },
            "post_code": "WR1 1AB",
            "tel_no": "07123456789",
            "mobile_tel_no": "",
            "fax_no": ""
        }
    },
    "delivery_address": {
        "recipient_name": "Bob Smith",
        "business_name": "",
        "line_1": "12 Fake Street",
        "line_2": "",
        "town": "Worcester",
        "region": {
            "href": "\/regions\/243.json",
            "country": "UK",
            "county": "Worcestershire"
        },
        "post_code": "WR1 1AB",
        "tel_no": "07123456789",
        "mobile_tel_no": "",
        "fax_no": ""
    },
    "tracking": {
        "medium": "direct",
        "source": "",
        "term": "",
        "using_stored_data": 0
    },
    "totals": {
        "qty": 3,
        "price": "0.00",
        "vat": "25.70",
        "weight": 0,
        "delivery": "0.00"
    },
    "lines": [
        {
            "id": 19990,
            "line_rel_id": 19988,
            "line_type": "OPTION",
            "line_desc": "Saver Discount - Yes ",
            "rel_data": {
                "option": {
                    "href": "\/options\/12349.json",
                    "id": 12349,
                    "group": "Saver Discount",
                    "desc": "Yes",
                    "code": "",
                    "product": {
                        "href": "\/products\/58661.json",
                        "id": 58661
                    }
                }
            },
            "status": "Payment Received",
            "qty": 1,
            "price": "0.00",
            "vat": "0.00",
            "vat_percentage": 20,
            "each_price_ex_vat": 0,
            "each_price_vat": 0,
            "each_price_discount_ex_vat": "0.00",
            "each_price_discount_vat": 0,
            "weight": 0
        },
        {
            "id": 19989,
            "line_rel_id": 19988,
            "line_type": "OPTION",
            "line_desc": "Multi Pack - Yes ",
            "rel_data": {
                "option": {
                    "href": "\/options\/12347.json",
                    "id": 12347,
                    "group": "Multi Pack",
                    "desc": "Yes",
                    "code": "",
                    "product": {
                        "href": "\/products\/58661.json",
                        "id": 58661
                    }
                }
            },
            "status": "Payment Received",
            "qty": 1,
            "price": "0.00",
            "vat": "0.00",
            "vat_percentage": 20,
            "each_price_ex_vat": 0,
            "each_price_vat": 0,
            "each_price_discount_ex_vat": "0.00",
            "each_price_discount_vat": 0,
            "weight": 0
        },
        {
            "id": 19988,
            "line_rel_id": 0,
            "line_type": "PRODUCT",
            "line_desc": "Traeger Texas Spicy BBQ Sauce 16oz - Sauce-1105410-yes-yes",
            "rel_data": {
                "product": {
                    "href": "\/products\/58661.json",
                    "id": 58661,
                    "name": "Traeger Texas Spicy BBQ Sauce 16oz",
                    "code": "Sauce-1105410-yes-yes"
                }
            },
            "status": "Payment Received",
            "qty": 1,
            "price": "137.40",
            "vat": "22.90",
            "vat_percentage": 20,
            "each_price_ex_vat": 114.5,
            "each_price_vat": 22.900000000000006,
            "each_price_discount_ex_vat": "0.00",
            "each_price_discount_vat": 0,
            "weight": 0
        },
        {
            "id": 19991,
            "line_rel_id": 0,
            "line_type": "PRODUCT",
            "line_desc": "Tubby Tom's The Squealer Hot Sauce 150g - Sauce-997706",
            "rel_data": {
                "product": {
                    "href": "\/products\/58662.json",
                    "id": 58662,
                    "name": "Tubby Tom's The Squealer Hot Sauce 150g",
                    "code": "Sauce-997706"
                }
            },
            "status": "Payment Received",
            "qty": 2,
            "price": "16.80",
            "vat": "2.80",
            "vat_percentage": 20,
            "each_price_ex_vat": 7,
            "each_price_vat": 1.4000000000000004,
            "each_price_discount_ex_vat": "0.00",
            "each_price_discount_vat": 0,
            "weight": 0
        },
        {
            "id": 19992,
            "line_rel_id": 0,
            "line_type": "DELIVERY",
            "line_desc": "Standard",
            "rel_data": {
                "delivery": {
                    "href": "\/delivery-methods\/1.json",
                    "id": 1,
                    "name": "Standard"
                }
            },
            "status": "Payment Received",
            "qty": 1,
            "price": "0.00",
            "vat": "0.00",
            "vat_percentage": 20,
            "each_price_ex_vat": 0,
            "each_price_vat": 0,
            "each_price_discount_ex_vat": 0,
            "each_price_discount_vat": 0,
            "weight": 0
        },
        {
            "id": 19995,
            "line_rel_id": 0,
            "line_type": "COUPON",
            "line_desc": "Gift Voucher for &pound;400.00 - C46K13i8",
            "rel_data": {
                "coupon": {
                    "href": "\/coupons\/72.json",
                    "id": 72,
                    "name": "Gift Voucher for &pound;400.00",
                    "code": "C46K13i8"
                }
            },
            "status": "Payment Received",
            "qty": 1,
            "price": "-154.20",
            "vat": "0.00",
            "vat_percentage": 0,
            "each_price_ex_vat": -154.2,
            "each_price_vat": 0,
            "each_price_discount_ex_vat": 0,
            "each_price_discount_vat": 0,
            "weight": 0
        }
    ],
    "is_free_delivery": false,
    "customers_order_id": "",
    "fob": "",
    "required_by_date": "",
    "purchase_order_number": "",
    "delivery_note": ""
}</code></pre>

                <p>We use HTTP status codes for responses (such as 200 for success, 201 for created, 204 for updated, 4XX statuses for bad requests such as 404 not found, 400 for missing requirements etc). We recommend using these in your implementation, however if your API client cannot handle these, you can surpress them to all return as 200 with <code>suppress_response_codes=true</code>.</p>

                <p>Date format: ISO 8601 - Complete date plus hours, minutes and seconds YYYY-MM-DDTHH:MM:SS <small>(Timezone is the site timezone, e.g. Europe/London)</small></p>

                <p>Encoding for all responses: UTF-8</p>

            </section>

            <section class="doc-section">
                <header>
                    <h2 id="resources">Resources</h2>
                </header>

                <p>Here's a list of the API resources available under <code>/api/v1</code>:</p>

                <div id="resources--blog-posts" class="endpoint">
                    <h3>Blog Posts</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/blog-posts</code>
                            <span class="request__info">List of blog posts</span>
                            <span class="request__filters">filters: <code>category</code> - category id</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/blog-posts/<strong>{id}</strong></code>
                            <span class="request__info">List of blog posts</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--categories" class="endpoint">
                    <h3>Categories</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/categories</code>
                            <span class="request__info">List collection of categories</span>
                            <span class="request__filters">filters: <code>parent</code> - filter by parent category id, <code>since_timestamp</code> (categories modified since timestamp, e.g. <code>?since_timestamp=1591970309</code> or <code>?since_timestamp=2020-06-11T07:45:02</code> - both accepted), <code>sort</code> (order to return products in - sort_order, id, live, updated, name)</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/categories/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific category</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--coupons" class="endpoint">
                    <h3>Coupons</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/coupons</code>
                            <span class="request__info">List collection of coupons</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/coupons/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve a specific coupon</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--delivery-methods" class="endpoint">
                    <h3>Delivery Methods</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/delivery-methods</code>
                            <span class="request__info">List collection of delivery methods</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/delivery-methods/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve a specific delivery method</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--departments" class="endpoint">
                    <h3>Departments</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/departments</code>
                            <span class="request__info">List collection of departments</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/departments/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve specific department</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--downloads" class="endpoint">
                    <h3>Downloads</h3>
                    <ul>
                        <li class="endpoint__identifiers">identifiers: <code>id</code>, <code>srchash</code> - a sha1 of the initial location, if updated later the initial/previous srchash is maintained</li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/downloads</code>
                            <span class="request__info">List collection of downloads</span>
                            <span class="request__filters">filters: <code>category</code> - filter downloads by category id, <code>ids</code> - filter downloads by a comma separated list of ids</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/downloads/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific download</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/downloads</code>
                            <span class="request__info">Batch create or update downloads</span>
                            <span class="request__requirements">required fields: <code>downloads</code> - array of download objects</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/downloads/<strong>{id}</strong></code>
                            <span class="request__info">Update a specific download</span>
                            <span class="request__requirements">required fields: <code>name</code>, <code>src</code></span>
                        </li>
                        <li class="request" data-http-method="DELETE">
                            <code class="request__url">/downloads</code>
                            <span class="request__info">Batch delete downloads</span>
                            <span class="request__requirements">required fields: <code>ids</code> - comma separated list of ids to delete</span>
                        </li>
                        <li class="request" data-http-method="DELETE">
                            <code class="request__url">/downloads/<strong>{id}</strong></code>
                            <span class="request__info">Delete a specific download</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--download-categories" class="endpoint">
                    <h3>Download categories</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/download-categories</code>
                            <span class="request__info">List collection of downloads categories</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/download-categories/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific download category</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--gallery" class="endpoint">
                    <h3>Gallery</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/gallery</code>
                            <span class="request__info">List of gallery images</span>
                            <span class="request__filters">filters: <code>album</code> - filter gallery images by album id</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/gallery/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific gallery image</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--google-reviews" class="endpoint">
                    <h3>Google Reviews</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/google-reviews</code>
                            <span class="request__info">List of google reviews for the site</span>
                            <span class="request__filters">filters: <code>average</code> - filter by minimum average rating</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/google-reviews/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific review</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--manufacturers" class="endpoint">
                    <h3>Manufacturers</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/manufacturers</code>
                            <span class="request__info">List collection of manufacturers</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/manufacturers/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve specific manufacturer</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--newsletters" class="endpoint">
                    <h3>Newsletters</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/newsletters</code>
                            <span class="request__info">List collection of newsletters</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/newsletters/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve a specific newsletter</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--options" class="endpoint">
                    <h3>Options</h3>
                    <ul>
                        <li class="endpoint__identifiers">identifiers: <code>id</code>, <code>code</code>, <code>name</code></li>
                        <li class="endpoint__identifiers">Though this resource is available, it's recommended to manage options directly on their products.</li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/options</code>
                            <span class="request__info">List collection of options</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/options/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific option</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/options</code>
                            <span class="request__info">Batch create or update options</span>
                            <span class="request__requirements">required fields: <code>options</code> - array of option objects</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/options/<strong>{id}</strong></code>
                            <span class="request__info">Update a specific option</span>
                            <span class="request__requirements">required fields: <code>product_id</code>, <code>group</code> (e.g. Size), <code>desc</code> (e.g. Medium)</span>
                        </li>
                        <li class="request" data-http-method="DELETE">
                            <code class="request__url">/options</code>
                            <span class="request__info">Batch delete options</span>
                            <span class="request__requirements">required fields: <code>ids</code> - comma separated list of ids to delete</span>
                        </li>
                        <li class="request" data-http-method="DELETE">
                            <code class="request__url">/options/<strong>{id}</strong></code>
                            <span class="request__info">Delete a specific option</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--orders" class="endpoint">
                    <h3>Orders</h3>
                    <ul>
                        <li class="endpoint__identifiers">identifiers: <code>id</code>, <code>invoice_id</code></li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/orders</code>
                            <span class="request__info">List collection of orders</span>
                            <span class="request__filters">filters: <code>since_timestamp</code> (orders placed since timestamp, e.g. <code>?since_timestamp=1591970309</code> or <code>?since_timestamp=2020-06-11T07:45:02</code> - both accepted)</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/orders/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific order</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/orders</code>
                            <span class="request__info">Batch update orders</span>
                            <span class="request__requirements">required fields: <code>orders</code> - array of order objects</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/orders/<strong>{id}</strong></code>
                            <span class="request__info">Update a specific order</span>
                            <span class="request__requirements">required fields: <code>status</code> (see Admin > Order Statuses)</span>
                            <span class="request__requirements">updatable fields: <code>customers_order_id</code>, <code>fob</code>, <code>purchase_order_number</code>, <code>required_by_date</code>, <code>status</code>, <code>delivery_note</code></span>
                        </li>
                    </ul>
                </div>

                <div id="resources--pages" class="endpoint">
                    <h3>Pages</h3>
                    <ul>
                        <li class="endpoint__identifiers">identifiers: <code>id</code>, <code>slug</code></li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/pages</code>
                            <span class="request__info">List collection of pages</span>
                            <span class="request__filters">filters: parent (id of parent page)</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/pages/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve a specific page</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--payment-methods" class="endpoint">
                    <h3>Payment Methods</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/payment-methods</code>
                            <span class="request__info">List collection of payment methods</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/payment-methods/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve a specific payment method</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--product-filter-blocks" class="endpoint">
                    <h3>Product Filter Blocks</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/product-filter-blocks</code>
                            <span class="request__info">List collection of product filter search blocks</span>
                            <span class="request__filters">filters: <code>remaining_only</code> (filter to only show product filter blocks with remaining products)</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/product-filter-blocks/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific product filter search blocks</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/products/filter/<strong>size,med/color,red,blue</strong></code>
                            <span class="request__info">Filter the blocks returned with filter params (based on site front end product filter params)</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--product-reviews" class="endpoint">
                    <h3>Product Reviews</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/product-reviews</code>
                            <span class="request__info">List collection of product reviews</span>
                            <span class="request__filters">filters: <code>product_id</code>, <code>featured</code>, <code>score_over</code>, <code>verified_purchase</code></span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/product-reviews/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve a specific product review</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--products" class="endpoint">
                    <h3>Products</h3>
                    <ul>
                        <li class="endpoint__identifiers">identifiers: <code>id</code>, <code>code</code>, <code>name</code>, e.g. <code>/products/{code}?identifier=code</code></li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/products</code>
                            <span class="request__info">List / filter collection of products</span>
                            <span class="request__filters">filters: <code>use_non_vat_prices=1</code> (use non-VAT prices), <code>ids</code> (comma separated ids), <code>category</code> (filter to products in a specific category id), <code>status</code>, <code>tags</code>, <code>q</code> (text search over: id, code, name, desc columns, optionally restrict these fields with <code>q_fields</code>), <code>since_timestamp</code> (products made live since timestamp, e.g. <code>?since_timestamp=1591970309</code> or <code>?since_timestamp=2020-06-11T07:45:02</code> - both accepted), <code>since_timestamp_field</code> (field to use for <code>?since_timestamp</code> - one of: live, updated), <code>sort</code> (order to return products in - sort_order, id, live, updated, name, code)</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/products/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific product</span>
                            <span class="request__requirements">Sites using variations (option combinations of products) allow lookups by both product code and variation code using the code identifier. However updates and deletes are on top level products only. For variation level changes to prices use product options and variation stock/cost updates use the <code>/stock</code> resource.</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/products</code>
                            <span class="request__info">Batch create or update products</span>
                            <span class="request__requirements">required fields: <code>products</code> - array of product objects, e.g. <code>{"products": [{...}, ...]}</code></span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/products/<strong>{id}</strong></code>
                            <span class="request__info">Update a specific product</span>
                            <span class="request__requirements">required fields: <code>name</code></span>
                            <span class="request__requirements">suggested fields: <code>code</code>, <code>desc</code>, <code>price</code>, <code>image</code>, <code>status</code> (draft, live, featured, special_offer, upcoming, deleted)</span>
                        </li>
                        <li class="request" data-http-method="DELETE">
                            <code class="request__url">/products</code>
                            <span class="request__info">Batch delete products</span>
                            <span class="request__requirements">required fields: <code>ids</code> - comma separated list of ids to delete</span>
                        </li>
                        <li class="request" data-http-method="DELETE">
                            <code class="request__url">/products/<strong>{id}</strong></code>
                            <span class="request__info">Delete a specific product</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/products/filter/<strong>size,med/color,red,blue</strong></code>
                            <span class="request__info">Filter products returned with filter params (based on site front end product filter params)</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--regions" class="endpoint">
                    <h3>Regions</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/regions</code>
                            <span class="request__info">List collection of categories</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/regions/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific category</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--sliders" class="endpoint">
                    <h3>Sliders</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/sliders</code>
                            <span class="request__info">List collection of sliders</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/sliders/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve a specific slider</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--stock" class="endpoint">
                    <h3>Stock</h3>
                    <ul>
                        <li class="endpoint__identifiers">The difference between this and the products resource is this a simpler stock focused endpoint, that also supports variation level codes and stock.</li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/stock</code>
                            <span class="request__info">List stock with code, stock qty & costs</span>
                            <span class="request__filters">filters: <code>codes</code> (filter stock by a comma separated list of codes)</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/stock/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve a code's stock</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/stock</code>
                            <span class="request__info">Batch update stock</span>
                            <span class="request__requirements">requires a direct array of stock objects, e.g. <code>[{"code": "xyz", "stock": 84, "cost": "3.50"}]</code></span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/stock/<strong>{id}</strong></code>
                            <span class="request__info">Update a specific code's stock</span>
                            <span class="request__requirements">required fields: <code>code</code>, <code>stock</code></span>
                        </li>
                    </ul>
                </div>

                <div id="resources--testimonials" class="endpoint">
                    <h3>Testimonials</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/testimonials</code>
                            <span class="request__info">List collection of testimonials</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/testimonials/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve a specific testimonial</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--user-groups" class="endpoint">
                    <h3>User Groups</h3>
                    <ul>
                        <li class="endpoint__identifiers">identifiers: <code>id</code>, <code>name</code></li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/user-groups</code>
                            <span class="request__info">List collection of user groups</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/user-groups/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific user group</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/user-groups</code>
                            <span class="request__info">Batch create or update user groups</span>
                            <span class="request__requirements">required fields: <code>user-groups</code> - array of user-group objects</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/user-groups/<strong>{id}</strong></code>
                            <span class="request__info">Update a specific user group</span>
                            <span class="request__requirements">required fields: <code>name</code></span>
                        </li>
                        <li class="request" data-http-method="DELETE">
                            <code class="request__url">/user-groups</code>
                            <span class="request__info">Batch delete user groups</span>
                            <span class="request__requirements">required fields: <code>ids</code> - comma separated list of ids to delete</span>
                        </li>
                        <li class="request" data-http-method="DELETE">
                            <code class="request__url">/user-groups/<strong>{id}</strong></code>
                            <span class="request__info">Delete a specific user group</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--userfiles" class="endpoint">
                    <h3>Userfiles</h3>
                    <ul>
                        <li class="endpoint__identifiers">This is an alternative to using FTP, supports managing a single file/image at a time.
                            <br>FTP support is also available for sites & API integrations directly to the userfiles directory.</li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/userfiles</code>
                            <span class="request__info">Create or update files to store such as product or category images.</span>
                            <span class="request__requirements">required fields: <code>filename</code> (e.g. "/userfiles/images/sys/x/y/z.png") and <code>body</code> (e.g. "data:image/png;base64,...")</span>
                        </li>
                        <li class="request" data-http-method="DELETE">
                            <code class="request__url">/userfiles</code>
                            <span class="request__info">Delete a specific file, pass an object with the <code>filename</code> inside.</span>
                        </li>
                    </ul>
                </div>

                <div id="resources--users" class="endpoint">
                    <h3>Users</h3>
                    <ul>
                        <li class="endpoint__identifiers">identifiers: <code>id</code>, <code>membership_code</code>, <code>email</code></li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/users</code>
                            <span class="request__info">List collection of users</span>
                            <span class="request__filters">filters: <code>use_non_vat_prices=1</code> (use non-VAT prices for per user delivery_charges)</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/users/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve data on a specific user</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/users</code>
                            <span class="request__info">Batch create or update users</span>
                            <span class="request__requirements">required fields: <code>users</code> - array of user objects</span>
                        </li>
                        <li class="request" data-http-method="POST">
                            <code class="request__url">/users/<strong>{id}</strong></code>
                            <span class="request__info">Update a specific user</span>
                            <span class="request__requirements">required fields: <code>full_name</code>, <code>email</code></span>
                        </li>
                    </ul>
                </div>

                <div id="resources--vat-types" class="endpoint">
                    <h3>VAT Types</h3>
                    <ul>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/vat-types</code>
                            <span class="request__info">List collection of vat types</span>
                        </li>
                        <li class="request" data-http-method="GET">
                            <code class="request__url">/vat-types/<strong>{id}</strong></code>
                            <span class="request__info">Retrieve specific vat type</span>
                        </li>
                    </ul>
                </div>

                <p>Some of the above resources show identifiers supported. If not otherwise shown, ID is assumed. For those with multiple possible identifiers, these give you an alternative to lookup resources using the <code>identifier</code> param, e.g. products support product code based lookups with <code>/products/{code}?identifier=code</code>.</p>
                <p>All collection resources support <code>limit</code> and <code>offset</code> which can be used to page through results, generally the default on lists is 25 and the max for the limit is generally 1000. See examples in the <code>paging</code> property of collection responses.</p>
                <p>Also most collection resources should support the <code>fields=*</code> url param, which allows full data on each views to be pulled back instead of just the basic data. </p>
                <p>The following resources also allow a <code>diffOnly=true</code> url param to show only changes that would be made without applying them live: downloads, options, orders, products, stock, user groups, users.</p>
                <p>For JSON responses, there's a <code>prettyPrint=true</code> param which can be useful as well as a <code>callback</code> param for front-end JSONP support if needed.</p>
                <p>For POST updates, we recommend sending JSON as the request body. However if you'd prefer to use form-urlencoded params the you can send the JSON in a <code>packet</code> param.</p>
                <p>Need access to anything not currently available or other new API functionality? <a href="https://support.reallyeasycart.co.uk/support/tickets/new" target="_blank">Request via a support ticket</a>.</p>

            </section>

            <section class="doc-section">
                <header>
                    <h2 id="api-webhooks">API Webhooks</h2>
                </header>

                <p>Webhooks react to events on the site and send to a specific endpoint.
                    <br>This allows you to host your own endpoint and receive in our API objects on events such as <code>new.order</code>, <code>update.order</code>, <code>new.user</code>, <code>update.user</code>, <code>new.product</code>, <code>update.product</code>, <code>delete.product</code>, <code>batch-update.product</code>, <code>batch-delete.product</code> and many more available.</p>

                <p>Webhooks send the same API objects as you’d get looking up that data from the API, e.g. <code>new.order</code> for order #123 would send you the JSON the same as you’d get if you were to request: <code>/api/v1/orders/123</code> via the API.</p>

                <p>Set these up via Admin > API Webhooks</p>

                <p>
                    <img src="/images/api/api-webhooks.png" alt="API Webhooks view">
                </p>

                <p>Webhooks support sending directly with HTTPS but optionally can also send with HTTP Basic Auth or HTTP Bearer Auth (for JWT). Like the API itself, they also support sending as XML if required though JSON is recommended.</p>

                <p>To accept multiple webhook events, you could add multiple webhooks with different URLs, or use a single endpoint URL and enable the "Wrap Data" option which wil send the API object wrapped in an outer object that indicates which event triggered it, e.g. <code>{"event": "event.name", "data": {...}}</code></p>
            </section>

            <section class="doc-section">
                <header>
                    <h2 id="api-explorer">API Explorer</h2>
                </header>

                <p>The API explorer allows you to see real API GET responses directly inside the admin of the site.</p>

                <p>Rather than fake examples, you can preview the exact same response without writing a single line of code.</p>

                <p>Check this out in Admin > API Explorer.</p>

                <p>
                    <img src="/images/api/api-explorer.png" alt="API Explorer view">
                </p>

                <p>Alongside the API Explorer is a new Event Simulator.</p>
                <p>This allows you to send real API objects from the website to your webhooks using the ApiWebHooks Hook for any given event and base input object.</p>
                <p>E.g. <code>{"product_id":XXX}</code> to send a <code>new.product</code> or <code>update.product</code> event.</p>

                <p>
                    <img src="/images/api/api-event-sim.png" alt="API Event Simulator view">
                </p>

                <p>This saves you from needing to continuously place orders or add/update products to test your integration.</p>
            </section>

            <section class="doc-section">
                <header>
                    <h2 id="further-reading">Further Reading</h2>
                </header>

                <p>This quick overview is meant to help get you started with the API.</p>

                <p>We also have <a href="https://support.reallyeasycart.co.uk/support/solutions/folders/269622">additional documentation available here</a>.</p>

                <p>Please also feel free to contact us via our <a href="https://support.reallyeasycart.co.uk/support/tickets/new">support tickets here</a>.</p>

                <p>Thanks for reading.</p>
            </section>

        </main>

    </div>

    <footer class="page-footer">
        <strong><a href="https://www.recplus.co.uk/">REC+</a> API Quick Guide.</strong>
        <small>
            <a href="https://github.com/ReallyEasyCart/reallyeasycart.github.io/" target="_blank">
                <svg xmlns="http://www.w3.org/2000/svg" height="1em" viewBox="0 0 496 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2023 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
                Contribute to this guide on GitHub
            </a>
        </small>
    </footer>

    <!-- code highlighting -->
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/atom-one-dark.min.css">
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/php.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/bash.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/json.min.js"></script>
    <script>hljs.highlightAll();</script>
    <script>
    (function () {
        var toggleSubLinks = document.querySelectorAll('.toggle-sub-links');
        for (var i = 0; i < toggleSubLinks.length; i++) {
            toggleSubLinks[i].addEventListener('click', function (e) {
                e.preventDefault();
                var parent = this.parentNode;
                parent.classList.toggle('open');
            });
        }
    }());
    </script>

</body>
</html>