🔗eCommerce

Orders

Retrieve an overview list of all eCommerce orders from your website

get

/api/public/site/ecommerce/orders

Authorizations

SessionKeySiteID

Query parameters

propertiesstring · array

A comma seperated list of properties that you would like to retrieve, leave empty to get all properties

Example: name,slug,enabled

per_pageinteger

Number of items to retireve, maximum of 500

Example: 20

sort_typestring

Property by which to sort the results

Example: created_at

sort_orderstring

Order of results (asc or desc)

Example: desc

pageint

Page to retrieve number, to be used with per_page

Example: 1

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/ecommerce/orders' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Retrieve all eCommerce order data about an individual CRM user

get

/api/public/site/ecommerce/orders/user/{userID}

Authorizations

SessionKeySiteID

Path parameters

userIDstring · idrequired

The ID of the user

Example: 1234

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/ecommerce/orders/user/{userID}' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Retrieve all data about an individual eCommerce order

get

/api/public/site/ecommerce/orders/{id}

Authorizations

SessionKeySiteID

Path parameters

idstring · idrequired

The ID of the eCommerce order

Example: 1234

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/ecommerce/orders/{id}' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Products

Retrieve all products

get

/api/public/site/ecommerce/products

Authorizations

SessionKeySiteID

Query parameters

propertiesstring · array

A comma seperated list of properties that you would like to retrieve, leave empty to get all properties

Example: name,slug,enabled

per_pageinteger

Number of items to retireve, maximum of 500

Example: 20

sort_typestring

Property by which to sort the results

Example: created_at

sort_orderstring

Order of results (asc or desc)

Example: desc

pageint

Page to retrieve number, to be used with per_page

Example: 1

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/ecommerce/products' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Retrieve all data about an individual product

get

/api/public/site/ecommerce/products/{id}

Authorizations

SessionKeySiteID

Path parameters

idstring · idrequired

The ID of the Product

Example: 1234

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/ecommerce/products/{id}' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Update a Product

put

/api/public/site/ecommerce/products/{id}

Authorizations

SessionKeySiteID

Path parameters

idstringrequired

The Product Item ID

Example: 1

Body

namestringrequired

slugstring

enabledstringrequired

weightingstring

expiry_datestring

release_datestring

category_arrayobject[]

secure_zone_arrayobject[]

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

attributesobject[]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/public/site/ecommerce/products/{id}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
          }
        ]
      }
    ]
  }'

200

400

401

403

422

200

No body

OK

Create a Product

post

/api/public/site/ecommerce/products/create

Authorizations

SessionKeySiteID

Body

namestringrequired

slugstring

enabledstringrequired

weightingstring

expiry_datestring

release_datestring

category_arrayobject[]

secure_zone_arrayobject[]

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

attributesobject[]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/site/ecommerce/products/create' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
          }
        ]
      }
    ]
  }'

200

400

401

403

422

200

No body

OK