Siteglide.comAdminRoadmap

🔗eCommerce

Orders

Retrieve an overview list of all eCommerce orders from your website

GET/api/public/site/ecommerce/orders
Authorization
Query parameters
Response

OK

Request
const response = await fetch('/api/public/site/ecommerce/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieve all eCommerce order data about an individual CRM user

GET/api/public/site/ecommerce/orders/user/{userID}
Authorization
Path parameters
userID*string (id)

The ID of the user

Example: 1234
Response

OK

Request
const response = await fetch('/api/public/site/ecommerce/orders/user/{userID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieve all data about an individual eCommerce order

GET/api/public/site/ecommerce/orders/{id}
Authorization
Path parameters
id*string (id)

The ID of the eCommerce order

Example: 1234
Response

OK

Request
const response = await fetch('/api/public/site/ecommerce/orders/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Products

Retrieve all products

GET/api/public/site/ecommerce/products
Authorization
Query parameters
Response

OK

Request
const response = await fetch('/api/public/site/ecommerce/products', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieve all data about an individual product

GET/api/public/site/ecommerce/products/{id}
Authorization
Path parameters
id*string (id)

The ID of the Product

Example: 1234
Response

OK

Request
const response = await fetch('/api/public/site/ecommerce/products/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Update a Product

PUT/api/public/site/ecommerce/products/{id}
Authorization
Path parameters
id*string

The Product Item ID

Example: 1
Body

Your Products custom fields as a JSON object. When updating Attributes and Attribute Options, if you do not provide an ID then a new item will be made. Providing a valid ID will update the existing item. For more information on Product Database structure, please see this document

name*string
slugstring
enabled*string
weightingstring
expiry_datestring
release_datestring
category_arrayarray of object
secure_zone_arrayarray of object
module_field_14/product_1string
module_field_14/product_2string
module_field_14/product_3string
module_field_14/product_4string
module_field_14/product_5string
module_field_14/product/inventory/1string
module_field_14/product/inventory/2string
module_field_14/product/inventory/3string
module_field_14/product/price/aud/1string
module_field_14/product/price/aud/2string
module_field_14/product/price/cad/1string
module_field_14/product/price/cad/2string
module_field_14/product/price/eur/1string
module_field_14/product/price/eur/2string
module_field_14/product/price/gbp/1string
module_field_14/product/price/gbp/2string
module_field_14/product/price/nzd/1string
module_field_14/product/price/nzd/2string
module_field_14/product/price/usd/1string
module_field_14/product/price/usd/2string
attributesarray of object
Response

OK

Request
const response = await fetch('/api/public/site/ecommerce/products/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "enabled": "text"
    }),
});
const data = await response.json();

Create a Product

POST/api/public/site/ecommerce/products/create
Authorization
Body

Your Products custom fields as a JSON object. For more information on Product Database structure, please see this document

name*string
slugstring
enabled*string
weightingstring
expiry_datestring
release_datestring
category_arrayarray of object
secure_zone_arrayarray of object
module_field_14/product_1string
module_field_14/product_2string
module_field_14/product_3string
module_field_14/product_4string
module_field_14/product_5string
module_field_14/product/inventory/1string
module_field_14/product/inventory/2string
module_field_14/product/inventory/3string
module_field_14/product/price/aud/1string
module_field_14/product/price/aud/2string
module_field_14/product/price/aud/3string
module_field_14/product/price/aud/4string
module_field_14/product/price/cad/1string
module_field_14/product/price/cad/2string
module_field_14/product/price/cad/3string
module_field_14/product/price/cad/4string
module_field_14/product/price/eur/1string
module_field_14/product/price/eur/2string
module_field_14/product/price/eur/3string
module_field_14/product/price/eur/4string
module_field_14/product/price/gbp/1string
module_field_14/product/price/gbp/2string
module_field_14/product/price/gbp/3string
module_field_14/product/price/gbp/4string
module_field_14/product/price/nzd/1string
module_field_14/product/price/nzd/2string
module_field_14/product/price/nzd/3string
module_field_14/product/price/nzd/4string
module_field_14/product/price/usd/1string
module_field_14/product/price/usd/2string
module_field_14/product/price/usd/3string
module_field_14/product/price/usd/4string
attributesarray of object
Response

OK

Request
const response = await fetch('/api/public/site/ecommerce/products/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "enabled": "text"
    }),
});
const data = await response.json();

Last updated