eCommerce

Orders

Retrieve an overview list of all eCommerce orders from your website

get

Authorizations

x-api-keystringRequired

x-site-idstringRequired

Query parameters

propertiesstring · arrayOptional

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

Example: name,slug,enabled

per_pageintegerOptional

Number of items to retireve, maximum of 500

Example: 20

sort_typestringOptional

Property by which to sort the results

Example: created_at

sort_orderstringOptional

Order of results (asc or desc)

Example: desc

pageintOptional

Page to retrieve number, to be used with per_page

Example: 1

Responses

200

No content

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - The CRM does not contain any orders

422

Unprocessable Entity - Required data missing or data invalid

get

/ecommerce/orders

GET /api/site/v2/ecommerce/orders HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Accept: */*

No content

Retrieve all data about an individual eCommerce order

get

Authorizations

x-api-keystringRequired

x-site-idstringRequired

Path parameters

idstring · idRequired

The ID of the eCommerce order

Example: 1234

Responses

200

No content

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - eCommerce order does not exist

422

Unprocessable Entity - Required data missing or data invalid

get

/ecommerce/orders/{id}

GET /api/site/v2/ecommerce/orders/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Accept: */*

No content

Retrieve all eCommerce order data about an individual CRM user

get

Authorizations

x-api-keystringRequired

x-site-idstringRequired

Path parameters

userIDstring · idRequired

The ID of the user

Example: 1234

Responses

200

No content

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - eCommerce order does not exist

422

Unprocessable Entity - Required data missing or data invalid

get

/ecommerce/orders/user/{userID}

GET /api/site/v2/ecommerce/orders/user/{userID} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Accept: */*

No content

Products

Retrieve all products

get

Authorizations

x-api-keystringRequired

x-site-idstringRequired

Query parameters

propertiesstring · arrayOptional

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

Example: name,slug,enabled

per_pageintegerOptional

Number of items to retireve, maximum of 500

Example: 20

sort_typestringOptional

Property by which to sort the results

Example: created_at

sort_orderstringOptional

Order of results (asc or desc)

Example: desc

pageintOptional

Page to retrieve number, to be used with per_page

Example: 1

Responses

200

No content

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - Product does not exist or this site has no products

422

Unprocessable Entity - Required data missing or data invalid

get

/ecommerce/products

GET /api/site/v2/ecommerce/products HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Accept: */*

No content

Retrieve all data about an individual product

get

Authorizations

x-api-keystringRequired

x-site-idstringRequired

Path parameters

idstring · idRequired

The ID of the Product

Example: 1234

Responses

200

No content

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - Product does not exist

422

Unprocessable Entity - Required data missing or data invalid

get

/ecommerce/products/{id}

GET /api/site/v2/ecommerce/products/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Accept: */*

No content

Update a Product

put

Authorizations

x-api-keystringRequired

x-site-idstringRequired

Path parameters

idstringRequired

The Product Item ID

Example: 1

Body

namestringRequired

slugstringOptional

enabledstringRequired

weightingstringOptional

expiry_datestringOptional

release_datestringOptional

category_arrayobject[]Optional

secure_zone_arrayobject[]Optional

module_field_14/product_1stringOptional

module_field_14/product_2stringOptional

module_field_14/product_3stringOptional

module_field_14/product_4stringOptional

module_field_14/product_5stringOptional

module_field_14/product/inventory/1stringOptional

module_field_14/product/inventory/2stringOptional

module_field_14/product/inventory/3stringOptional

module_field_14/product/price/aud/1stringOptional

module_field_14/product/price/aud/2stringOptional

module_field_14/product/price/cad/1stringOptional

module_field_14/product/price/cad/2stringOptional

module_field_14/product/price/eur/1stringOptional

module_field_14/product/price/eur/2stringOptional

module_field_14/product/price/gbp/1stringOptional

module_field_14/product/price/gbp/2stringOptional

module_field_14/product/price/nzd/1stringOptional

module_field_14/product/price/nzd/2stringOptional

module_field_14/product/price/usd/1stringOptional

module_field_14/product/price/usd/2stringOptional

Responses

200

No content

400

Bad Request - The API could not understand the request due to invalid syntax.

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

422

Unprocessable Entity - Required data missing or data invalid

put

/ecommerce/products/{id}

PUT /api/site/v2/ecommerce/products/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: 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

Create a Product

post

Authorizations

x-api-keystringRequired

x-site-idstringRequired

Body

namestringRequired

slugstringOptional

enabledstringRequired

weightingstringOptional

expiry_datestringOptional

release_datestringOptional

category_arrayobject[]Optional

secure_zone_arrayobject[]Optional

module_field_14/product_1stringOptional

module_field_14/product_2stringOptional

module_field_14/product_3stringOptional

module_field_14/product_4stringOptional

module_field_14/product_5stringOptional

module_field_14/product/inventory/1stringOptional

module_field_14/product/inventory/2stringOptional

module_field_14/product/inventory/3stringOptional

module_field_14/product/price/aud/1stringOptional

module_field_14/product/price/aud/2stringOptional

module_field_14/product/price/aud/3stringOptional

module_field_14/product/price/aud/4stringOptional

module_field_14/product/price/cad/1stringOptional

module_field_14/product/price/cad/2stringOptional

module_field_14/product/price/cad/3stringOptional

module_field_14/product/price/cad/4stringOptional

module_field_14/product/price/eur/1stringOptional

module_field_14/product/price/eur/2stringOptional

module_field_14/product/price/eur/3stringOptional

module_field_14/product/price/eur/4stringOptional

module_field_14/product/price/gbp/1stringOptional

module_field_14/product/price/gbp/2stringOptional

module_field_14/product/price/gbp/3stringOptional

module_field_14/product/price/gbp/4stringOptional

module_field_14/product/price/nzd/1stringOptional

module_field_14/product/price/nzd/2stringOptional

module_field_14/product/price/nzd/3stringOptional

module_field_14/product/price/nzd/4stringOptional

module_field_14/product/price/usd/1stringOptional

module_field_14/product/price/usd/2stringOptional

module_field_14/product/price/usd/3stringOptional

module_field_14/product/price/usd/4stringOptional

Responses

200

No content

400

Bad Request - The API could not understand the request due to invalid syntax.

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

422

Unprocessable Entity - Required data missing or data invalid

post

/ecommerce/products/create

POST /api/site/v2/ecommerce/products/create HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: 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

PreviousCRM Users NextSite API Changelog

Last updated 5 months ago

Was this helpful?