eCommerce
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
A comma seperated list of properties that you would like to retrieve, leave empty to get all properties
name,slug,enabled
Number of items to retireve, maximum of 500
20
Property by which to sort the results
created_at
Order of results (asc or desc)
desc
Page to retrieve number, to be used with per_page
1
OK
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Not Found - The CRM does not contain any orders
Unprocessable Entity - Required data missing or data invalid
GET /api/site/v2/ecommerce/orders HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*
No content
The ID of the eCommerce order
1234
OK
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Not Found - eCommerce order does not exist
Unprocessable Entity - Required data missing or data invalid
GET /api/site/v2/ecommerce/orders/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*
No content
The ID of the user
1234
OK
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Not Found - eCommerce order does not exist
Unprocessable Entity - Required data missing or data invalid
GET /api/site/v2/ecommerce/orders/user/{userID} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*
No content
A comma seperated list of properties that you would like to retrieve, leave empty to get all properties
name,slug,enabled
Number of items to retireve, maximum of 500
20
Property by which to sort the results
created_at
Order of results (asc or desc)
desc
Page to retrieve number, to be used with per_page
1
OK
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Not Found - Product does not exist or this site has no products
Unprocessable Entity - Required data missing or data invalid
GET /api/site/v2/ecommerce/products HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*
No content
The ID of the Product
1234
OK
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Not Found - Product does not exist
Unprocessable Entity - Required data missing or data invalid
GET /api/site/v2/ecommerce/products/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Accept: */*
No content
The Product Item ID
1
OK
Bad Request - The API could not understand the request due to invalid syntax.
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Unprocessable Entity - Required data missing or data invalid
PUT /api/site/v2/ecommerce/products/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2117
{
"name": "text",
"slug": "text",
"enabled": "text",
"weighting": "text",
"expiry_date": "text",
"release_date": "text",
"category_array": [
{}
],
"secure_zone_array": [
{}
],
"module_field_14/product_1": "text",
"module_field_14/product_2": "text",
"module_field_14/product_3": "text",
"module_field_14/product_4": "text",
"module_field_14/product_5": "text",
"module_field_14/product/inventory/1": "text",
"module_field_14/product/inventory/2": "text",
"module_field_14/product/inventory/3": "text",
"module_field_14/product/price/aud/1": "text",
"module_field_14/product/price/aud/2": "text",
"module_field_14/product/price/cad/1": "text",
"module_field_14/product/price/cad/2": "text",
"module_field_14/product/price/eur/1": "text",
"module_field_14/product/price/eur/2": "text",
"module_field_14/product/price/gbp/1": "text",
"module_field_14/product/price/gbp/2": "text",
"module_field_14/product/price/nzd/1": "text",
"module_field_14/product/price/nzd/2": "text",
"module_field_14/product/price/usd/1": "text",
"module_field_14/product/price/usd/2": "text",
"attributes": [
{
"id": "text",
"name": "text",
"items": [
{
"id": "text",
"name": "text",
"enabled": "text",
"module_field_14/product_attribute_option_2": "text",
"module_field_14/product_attribute_option_3": "text",
"module_field_14/product_attribute_option_4": "text",
"module_field_14/product_attribute_option_6": "text",
"module_field_14/product_attribute_option/price/aud/1": "text",
"module_field_14/product_attribute_option/price/aud/2": "text",
"module_field_14/product_attribute_option/price/cad/1": "text",
"module_field_14/product_attribute_option/price/cad/2": "text",
"module_field_14/product_attribute_option/price/eur/1": "text",
"module_field_14/product_attribute_option/price/eur/2": "text",
"module_field_14/product_attribute_option/price/gbp/1": "text",
"module_field_14/product_attribute_option/price/gbp/2": "text",
"module_field_14/product_attribute_option/price/nzd/1": "text",
"module_field_14/product_attribute_option/price/nzd/2": "text",
"module_field_14/product_attribute_option/price/usd/1": "text",
"module_field_14/product_attribute_option/price/usd/2": "text",
"module_field_14/product_attribute_option/inventory/1": "text"
}
]
}
]
}
No content
OK
Bad Request - The API could not understand the request due to invalid syntax.
Unauthorized - Credentials Incorrect
Forbidden - You cannot access this site
Unprocessable Entity - Required data missing or data invalid
POST /api/site/v2/ecommerce/products/create HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2650
{
"name": "text",
"slug": "text",
"enabled": "text",
"weighting": "text",
"expiry_date": "text",
"release_date": "text",
"category_array": [
{}
],
"secure_zone_array": [
{}
],
"module_field_14/product_1": "text",
"module_field_14/product_2": "text",
"module_field_14/product_3": "text",
"module_field_14/product_4": "text",
"module_field_14/product_5": "text",
"module_field_14/product/inventory/1": "text",
"module_field_14/product/inventory/2": "text",
"module_field_14/product/inventory/3": "text",
"module_field_14/product/price/aud/1": "text",
"module_field_14/product/price/aud/2": "text",
"module_field_14/product/price/aud/3": "text",
"module_field_14/product/price/aud/4": "text",
"module_field_14/product/price/cad/1": "text",
"module_field_14/product/price/cad/2": "text",
"module_field_14/product/price/cad/3": "text",
"module_field_14/product/price/cad/4": "text",
"module_field_14/product/price/eur/1": "text",
"module_field_14/product/price/eur/2": "text",
"module_field_14/product/price/eur/3": "text",
"module_field_14/product/price/eur/4": "text",
"module_field_14/product/price/gbp/1": "text",
"module_field_14/product/price/gbp/2": "text",
"module_field_14/product/price/gbp/3": "text",
"module_field_14/product/price/gbp/4": "text",
"module_field_14/product/price/nzd/1": "text",
"module_field_14/product/price/nzd/2": "text",
"module_field_14/product/price/nzd/3": "text",
"module_field_14/product/price/nzd/4": "text",
"module_field_14/product/price/usd/1": "text",
"module_field_14/product/price/usd/2": "text",
"module_field_14/product/price/usd/3": "text",
"module_field_14/product/price/usd/4": "text",
"attributes": [
{
"name": "text",
"enabled": "text",
"items": [
{
"name": "text",
"enabled": "text",
"module_field_14/product_attribute_option_2": "text",
"module_field_14/product_attribute_option_3": "text",
"module_field_14/product_attribute_option_4": "text",
"module_field_14/product_attribute_option_6": "text",
"module_field_14/product_attribute_option/price/aud/1": "text",
"module_field_14/product_attribute_option/price/aud/2": "text",
"module_field_14/product_attribute_option/price/cad/1": "text",
"module_field_14/product_attribute_option/price/cad/2": "text",
"module_field_14/product_attribute_option/price/eur/1": "text",
"module_field_14/product_attribute_option/price/eur/2": "text",
"module_field_14/product_attribute_option/price/gbp/1": "text",
"module_field_14/product_attribute_option/price/gbp/2": "text",
"module_field_14/product_attribute_option/price/nzd/1": "text",
"module_field_14/product_attribute_option/price/nzd/2": "text",
"module_field_14/product_attribute_option/price/usd/1": "text",
"module_field_14/product_attribute_option/price/usd/2": "text",
"module_field_14/product_attribute_option/inventory/1": "text"
}
]
}
]
}
No content