NAV Navbar
Logo
Shell HTTP JavaScript Node.JS Python Ruby Java

iQX Amplify API Reference v1.0.0

Welcome to the iQX Amplify API reference. This is a live example of how you can use iQX Amplify to integrate your own e-commerce store or ticketing engine.

The iQX Amplify API is organized around the REST mothodology, and it uses resource-oriented URLs, and common HTTP response codes to indicate API errors. All requests are authenticated using an api-key which can be obtained from your developer dashboard within iQX Amplify.

Base URL

Terms of service Email: Support

Authentication

Stores

Store methods provide access to information and operations relating to the store.

FindStores

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/stores/
GET http://localhost:10010/V1/stores/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/stores/',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/stores/', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/stores/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/stores/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/stores/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /stores/

Retrieve all stores

Retrieve all stores

Responses

Status Meaning Description
200 OK Store response
default Default Error

Example responses

[
  {
    "_key": "string",
    "type": "string",
    "url": "string",
    "business_name": "string",
    "site_url": "string",
    "terms_of_service": "string",
    "modified_date": "2017-02-12T00:24:35Z",
    "has_integration": true,
    "whitelist_email_on_purchase": true,
    "whitelist_popup_on_purchase": true
  }
]
{}

CreateOrUpdateStore

Code samples

# You can also use wget
curl -X post http://localhost:10010/V1/stores/
POST http://localhost:10010/V1/stores/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/stores/',
    method: 'post',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/stores/', { method: 'POST'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:10010/V1/stores/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.post('http://localhost:10010/V1/stores/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/stores/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /stores/

Create or update a store

Create or update a store

Parameters

Parameter In Type Required Description
store body Store true Add or update store details

Body parameter

{
  "_key": "string",
  "type": "string",
  "url": "string",
  "business_name": "string",
  "site_url": "string",
  "terms_of_service": "string",
  "modified_date": "2017-02-12T00:24:35Z",
  "has_integration": true,
  "whitelist_email_on_purchase": true,
  "whitelist_popup_on_purchase": true
}

Responses

Status Meaning Description
200 OK Store object response
default Default Error

Example responses

[
  {
    "_key": "string",
    "type": "string",
    "url": "string",
    "business_name": "string",
    "site_url": "string",
    "terms_of_service": "string",
    "modified_date": "2017-02-12T00:24:35Z",
    "has_integration": true,
    "whitelist_email_on_purchase": true,
    "whitelist_popup_on_purchase": true
  }
]
{}

FindStoresById

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/stores/{id}
GET http://localhost:10010/V1/stores/{id} HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/stores/{id}',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/stores/{id}', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/stores/{id}', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/stores/{id}', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/stores/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /stores/{id}

Retrieve a single store by id

Retrieve a single store by id

Parameters

Parameter In Type Required Description
id path string true ID of the store to get

Responses

Status Meaning Description
200 OK Store object response
default Default Error

Example responses

{
  "_key": "string",
  "type": "string",
  "url": "string",
  "business_name": "string",
  "site_url": "string",
  "terms_of_service": "string",
  "modified_date": "2017-02-12T00:24:35Z",
  "has_integration": true,
  "whitelist_email_on_purchase": true,
  "whitelist_popup_on_purchase": true
}
{}

Customers

Customers methods provide access to information and operations relating to the customers.

FindCustomers

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/customers/
GET http://localhost:10010/V1/customers/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/customers/',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/customers/', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/customers/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/customers/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/customers/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /customers/

Retrieve all customers

Retrieve all customers

Responses

Status Meaning Description
200 OK Customer object response
default Default Error

Example responses

[
  {
    "_key": "string",
    "address1": "string",
    "address2": "string",
    "area_code": "string",
    "city": "string",
    "company": "string",
    "country": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "modified_date": "2017-02-12T00:24:35Z",
    "orders_count": 0,
    "phone": "string",
    "province": "string",
    "ref_id": "string",
    "signed_up_at": "2017-02-12T00:24:35Z",
    "time_zone_dst_offset": 0,
    "time_zone_id": "string",
    "time_zone_raw_offset": "string",
    "total_spent": 0,
    "user_id": "string",
    "valid_phone_number": true,
    "verified": true,
    "zip": "string"
  }
]
{}

CreateOrUpdateCustomer

Code samples

# You can also use wget
curl -X post http://localhost:10010/V1/customers/
POST http://localhost:10010/V1/customers/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/customers/',
    method: 'post',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/customers/', { method: 'POST'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:10010/V1/customers/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.post('http://localhost:10010/V1/customers/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/customers/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /customers/

Create or Update a customer

Create or Update a customer

Parameters

Parameter In Type Required Description
customer body Customer true Add or update customer details

Body parameter

{
  "_key": "string",
  "address1": "string",
  "address2": "string",
  "area_code": "string",
  "city": "string",
  "company": "string",
  "country": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "modified_date": "2017-02-12T00:24:35Z",
  "orders_count": 0,
  "phone": "string",
  "province": "string",
  "ref_id": "string",
  "signed_up_at": "2017-02-12T00:24:35Z",
  "time_zone_dst_offset": 0,
  "time_zone_id": "string",
  "time_zone_raw_offset": "string",
  "total_spent": 0,
  "user_id": "string",
  "valid_phone_number": true,
  "verified": true,
  "zip": "string"
}

Responses

Status Meaning Description
200 OK Store response
default Default Error

Example responses

[
  {
    "_key": "string",
    "address1": "string",
    "address2": "string",
    "area_code": "string",
    "city": "string",
    "company": "string",
    "country": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "modified_date": "2017-02-12T00:24:35Z",
    "orders_count": 0,
    "phone": "string",
    "province": "string",
    "ref_id": "string",
    "signed_up_at": "2017-02-12T00:24:35Z",
    "time_zone_dst_offset": 0,
    "time_zone_id": "string",
    "time_zone_raw_offset": "string",
    "total_spent": 0,
    "user_id": "string",
    "valid_phone_number": true,
    "verified": true,
    "zip": "string"
  }
]
{}

FindCustomersById

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/customers/{id}
GET http://localhost:10010/V1/customers/{id} HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/customers/{id}',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/customers/{id}', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/customers/{id}', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/customers/{id}', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/customers/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /customers/{id}

Retrieve a single customer by id

Retrieve a single customer by id

Parameters

Parameter In Type Required Description
id path string true ID of the customer to get

Responses

Status Meaning Description
200 OK Customer object response
default Default Error

Example responses

{
  "_key": "string",
  "address1": "string",
  "address2": "string",
  "area_code": "string",
  "city": "string",
  "company": "string",
  "country": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "modified_date": "2017-02-12T00:24:35Z",
  "orders_count": 0,
  "phone": "string",
  "province": "string",
  "ref_id": "string",
  "signed_up_at": "2017-02-12T00:24:35Z",
  "time_zone_dst_offset": 0,
  "time_zone_id": "string",
  "time_zone_raw_offset": "string",
  "total_spent": 0,
  "user_id": "string",
  "valid_phone_number": true,
  "verified": true,
  "zip": "string"
}
{}

Products

Products methods provide access to information and operations relating to the products.

FindProducts

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/products/
GET http://localhost:10010/V1/products/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/products/',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/products/', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/products/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/products/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/products/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /products/

Retrieve all products

Retrieve all products

Responses

Status Meaning Description
200 OK Product object response
default Default Error

Example responses

[
  {
    "_key": "string",
    "categories": "string",
    "currency": "string",
    "handle": "string",
    "image_source_url": "string",
    "image_thubnail": "string",
    "is_downloadable": true,
    "is_virtual": true,
    "keyword_locked": true,
    "out_stock": true,
    "price": 0,
    "price_compare": 0,
    "product_tags": [
      "string"
    ],
    "published_at": "2017-02-12T00:24:35Z",
    "ref_id": "string",
    "sku": "string",
    "source": "string",
    "tags": "string",
    "title": "string",
    "type": "string",
    "user_id": "string",
    "variants": [
      {
        "attributes": [
          {
            "name": "string",
            "option": "string",
            "slug": "string"
          }
        ],
        "created": "2017-02-12T00:24:35Z",
        "image_source_url": "string",
        "in_stock": true,
        "inventory_management": "string",
        "inventory_quantity": "string",
        "price": 0,
        "price_compare": 0,
        "product_ref_id": "string",
        "ref_id": "string",
        "sku": "string",
        "taxable": true,
        "title": "string",
        "updated": "2017-02-12T00:24:35Z",
        "visible": true,
        "weight": 0
      }
    ],
    "vendor": "string"
  }
]
{}

CreateOrUpdateProduct

Code samples

# You can also use wget
curl -X post http://localhost:10010/V1/products/
POST http://localhost:10010/V1/products/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/products/',
    method: 'post',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/products/', { method: 'POST'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:10010/V1/products/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.post('http://localhost:10010/V1/products/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/products/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /products/

Create or Update a product

Create or Update a product

Parameters

Parameter In Type Required Description
product body Product true Add or update products details

Body parameter

{
  "_key": "string",
  "categories": "string",
  "currency": "string",
  "handle": "string",
  "image_source_url": "string",
  "image_thubnail": "string",
  "is_downloadable": true,
  "is_virtual": true,
  "keyword_locked": true,
  "out_stock": true,
  "price": 0,
  "price_compare": 0,
  "product_tags": [
    "string"
  ],
  "published_at": "2017-02-12T00:24:35Z",
  "ref_id": "string",
  "sku": "string",
  "source": "string",
  "tags": "string",
  "title": "string",
  "type": "string",
  "user_id": "string",
  "variants": [
    {
      "attributes": [
        {
          "name": "string",
          "option": "string",
          "slug": "string"
        }
      ],
      "created": "2017-02-12T00:24:35Z",
      "image_source_url": "string",
      "in_stock": true,
      "inventory_management": "string",
      "inventory_quantity": "string",
      "price": 0,
      "price_compare": 0,
      "product_ref_id": "string",
      "ref_id": "string",
      "sku": "string",
      "taxable": true,
      "title": "string",
      "updated": "2017-02-12T00:24:35Z",
      "visible": true,
      "weight": 0
    }
  ],
  "vendor": "string"
}

Responses

Status Meaning Description
200 OK Store response
default Default Error

Example responses

[
  {
    "_key": "string",
    "categories": "string",
    "currency": "string",
    "handle": "string",
    "image_source_url": "string",
    "image_thubnail": "string",
    "is_downloadable": true,
    "is_virtual": true,
    "keyword_locked": true,
    "out_stock": true,
    "price": 0,
    "price_compare": 0,
    "product_tags": [
      "string"
    ],
    "published_at": "2017-02-12T00:24:35Z",
    "ref_id": "string",
    "sku": "string",
    "source": "string",
    "tags": "string",
    "title": "string",
    "type": "string",
    "user_id": "string",
    "variants": [
      {
        "attributes": [
          {
            "name": "string",
            "option": "string",
            "slug": "string"
          }
        ],
        "created": "2017-02-12T00:24:35Z",
        "image_source_url": "string",
        "in_stock": true,
        "inventory_management": "string",
        "inventory_quantity": "string",
        "price": 0,
        "price_compare": 0,
        "product_ref_id": "string",
        "ref_id": "string",
        "sku": "string",
        "taxable": true,
        "title": "string",
        "updated": "2017-02-12T00:24:35Z",
        "visible": true,
        "weight": 0
      }
    ],
    "vendor": "string"
  }
]
{}

FindProductsById

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/products/{id}
GET http://localhost:10010/V1/products/{id} HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/products/{id}',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/products/{id}', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/products/{id}', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/products/{id}', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/products/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /products/{id}

Retrieve a single product by id

Retrieve a single product by id

Parameters

Parameter In Type Required Description
id path string true ID of the product to get

Responses

Status Meaning Description
200 OK Product object response
default Default Error

Example responses

{
  "_key": "string",
  "categories": "string",
  "currency": "string",
  "handle": "string",
  "image_source_url": "string",
  "image_thubnail": "string",
  "is_downloadable": true,
  "is_virtual": true,
  "keyword_locked": true,
  "out_stock": true,
  "price": 0,
  "price_compare": 0,
  "product_tags": [
    "string"
  ],
  "published_at": "2017-02-12T00:24:35Z",
  "ref_id": "string",
  "sku": "string",
  "source": "string",
  "tags": "string",
  "title": "string",
  "type": "string",
  "user_id": "string",
  "variants": [
    {
      "attributes": [
        {
          "name": "string",
          "option": "string",
          "slug": "string"
        }
      ],
      "created": "2017-02-12T00:24:35Z",
      "image_source_url": "string",
      "in_stock": true,
      "inventory_management": "string",
      "inventory_quantity": "string",
      "price": 0,
      "price_compare": 0,
      "product_ref_id": "string",
      "ref_id": "string",
      "sku": "string",
      "taxable": true,
      "title": "string",
      "updated": "2017-02-12T00:24:35Z",
      "visible": true,
      "weight": 0
    }
  ],
  "vendor": "string"
}
{}

Orders

Orders methods provide access to information and operations relating to the orders.

FindOrders

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/orders/
GET http://localhost:10010/V1/orders/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/orders/',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/orders/', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/orders/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/orders/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/orders/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /orders/

Retrieve all orders

Retrieve all orders

Responses

Status Meaning Description
200 OK Order object response
default Default Error

Example responses

[
  {
    "_key": "string",
    "customer_ref_id": "string",
    "financial_status": "string",
    "iqx_order": "string",
    "line_items": [
      {
        "attributes": [
          {
            "fulfillable_quantity": 0,
            "price": 0,
            "product_ref_id": 0,
            "ref_id": 0,
            "sku": "string"
          }
        ]
      }
    ],
    "processed_at": "2017-02-12T00:24:35Z",
    "ref_id": 0,
    "subtotal_price": 0,
    "total_price": 0,
    "total_shipping": 0,
    "total_tax": 0,
    "user_id": "string"
  }
]
{}

CreateOrUpdateOrder

Code samples

# You can also use wget
curl -X post http://localhost:10010/V1/orders/
POST http://localhost:10010/V1/orders/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/orders/',
    method: 'post',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/orders/', { method: 'POST'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:10010/V1/orders/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.post('http://localhost:10010/V1/orders/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/orders/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /orders/

Create or Update a order

Create or Update a order

Parameters

Parameter In Type Required Description
order body Order true Add or update orders details

Body parameter

{
  "_key": "string",
  "customer_ref_id": "string",
  "financial_status": "string",
  "iqx_order": "string",
  "line_items": [
    {
      "attributes": [
        {
          "fulfillable_quantity": 0,
          "price": 0,
          "product_ref_id": 0,
          "ref_id": 0,
          "sku": "string"
        }
      ]
    }
  ],
  "processed_at": "2017-02-12T00:24:35Z",
  "ref_id": 0,
  "subtotal_price": 0,
  "total_price": 0,
  "total_shipping": 0,
  "total_tax": 0,
  "user_id": "string"
}

Responses

Status Meaning Description
200 OK Order response
default Default Error

Example responses

[
  {
    "_key": "string",
    "customer_ref_id": "string",
    "financial_status": "string",
    "iqx_order": "string",
    "line_items": [
      {
        "attributes": [
          {
            "fulfillable_quantity": 0,
            "price": 0,
            "product_ref_id": 0,
            "ref_id": 0,
            "sku": "string"
          }
        ]
      }
    ],
    "processed_at": "2017-02-12T00:24:35Z",
    "ref_id": 0,
    "subtotal_price": 0,
    "total_price": 0,
    "total_shipping": 0,
    "total_tax": 0,
    "user_id": "string"
  }
]
{}

FindOrdersById

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/orders/{id}
GET http://localhost:10010/V1/orders/{id} HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/orders/{id}',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/orders/{id}', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/orders/{id}', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/orders/{id}', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/orders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /orders/{id}

Retrieve a single order by id

Retrieve a single order by id

Parameters

Parameter In Type Required Description
id path string true ID of the order to get

Responses

Status Meaning Description
200 OK Order object response
default Default Error

Example responses

{
  "_key": "string",
  "customer_ref_id": "string",
  "financial_status": "string",
  "iqx_order": "string",
  "line_items": [
    {
      "attributes": [
        {
          "fulfillable_quantity": 0,
          "price": 0,
          "product_ref_id": 0,
          "ref_id": 0,
          "sku": "string"
        }
      ]
    }
  ],
  "processed_at": "2017-02-12T00:24:35Z",
  "ref_id": 0,
  "subtotal_price": 0,
  "total_price": 0,
  "total_shipping": 0,
  "total_tax": 0,
  "user_id": "string"
}
{}

Events

Events methods provide access to information and operations relating to the events.

FindEvents

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/events/
GET http://localhost:10010/V1/events/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/events/',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/events/', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/events/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/events/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/events/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /events/

Retrieve all events

Retrieve all events

Responses

Status Meaning Description
200 OK Event object response
default Default Error

Example responses

[
  {
    "_key": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "type": "string",
    "event_start_date": "2017-02-12T00:24:35Z",
    "event_end_date": "2017-02-12T00:24:35Z",
    "door_open_time": "2017-02-12T00:24:35Z",
    "door_close_time": "2017-02-12T00:24:35Z",
    "total_capacity": 0,
    "purchase_limit": 0,
    "event_url": "string",
    "currency": "string",
    "tickets": [
      {
        "_key": "string",
        "name": "string",
        "description": "string",
        "ticket_url": "string",
        "order": 0,
        "price": 0,
        "maximum_available": 0,
        "availability": {
          "date_restrictions_status": true,
          "date_restrictions_Start_date": "string",
          "date_restrictions_end_date": "string",
          "date_restrictions_Start_time": "string",
          "date_restrictions_end_time": "string"
        },
        "modified_date": "2017-02-12T00:24:35Z",
        "user_id": "string"
      }
    ],
    "time_zone": "string",
    "artist_name": "string",
    "venue": {
      "name": "string",
      "address": "string",
      "city": "string",
      "province": "string",
      "country": "string",
      "zip": "string"
    },
    "scanner_code": "string",
    "modified_date": "2017-02-12T00:24:35Z",
    "user_id": "string"
  }
]
{}

CreateOrUpdateEvent

Code samples

# You can also use wget
curl -X post http://localhost:10010/V1/events/
POST http://localhost:10010/V1/events/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/events/',
    method: 'post',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/events/', { method: 'POST'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:10010/V1/events/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.post('http://localhost:10010/V1/events/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/events/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /events/

Create or Update a event

Create or Update a event

Parameters

Parameter In Type Required Description
event body Event true Add or update events details

Body parameter

{
  "_key": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "type": "string",
  "event_start_date": "2017-02-12T00:24:35Z",
  "event_end_date": "2017-02-12T00:24:35Z",
  "door_open_time": "2017-02-12T00:24:35Z",
  "door_close_time": "2017-02-12T00:24:35Z",
  "total_capacity": 0,
  "purchase_limit": 0,
  "event_url": "string",
  "currency": "string",
  "tickets": [
    {
      "_key": "string",
      "name": "string",
      "description": "string",
      "ticket_url": "string",
      "order": 0,
      "price": 0,
      "maximum_available": 0,
      "availability": {
        "date_restrictions_status": true,
        "date_restrictions_Start_date": "string",
        "date_restrictions_end_date": "string",
        "date_restrictions_Start_time": "string",
        "date_restrictions_end_time": "string"
      },
      "modified_date": "2017-02-12T00:24:35Z",
      "user_id": "string"
    }
  ],
  "time_zone": "string",
  "artist_name": "string",
  "venue": {
    "name": "string",
    "address": "string",
    "city": "string",
    "province": "string",
    "country": "string",
    "zip": "string"
  },
  "scanner_code": "string",
  "modified_date": "2017-02-12T00:24:35Z",
  "user_id": "string"
}

Responses

Status Meaning Description
200 OK Event response
default Default Error

Example responses

[
  {
    "_key": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "type": "string",
    "event_start_date": "2017-02-12T00:24:35Z",
    "event_end_date": "2017-02-12T00:24:35Z",
    "door_open_time": "2017-02-12T00:24:35Z",
    "door_close_time": "2017-02-12T00:24:35Z",
    "total_capacity": 0,
    "purchase_limit": 0,
    "event_url": "string",
    "currency": "string",
    "tickets": [
      {
        "_key": "string",
        "name": "string",
        "description": "string",
        "ticket_url": "string",
        "order": 0,
        "price": 0,
        "maximum_available": 0,
        "availability": {
          "date_restrictions_status": true,
          "date_restrictions_Start_date": "string",
          "date_restrictions_end_date": "string",
          "date_restrictions_Start_time": "string",
          "date_restrictions_end_time": "string"
        },
        "modified_date": "2017-02-12T00:24:35Z",
        "user_id": "string"
      }
    ],
    "time_zone": "string",
    "artist_name": "string",
    "venue": {
      "name": "string",
      "address": "string",
      "city": "string",
      "province": "string",
      "country": "string",
      "zip": "string"
    },
    "scanner_code": "string",
    "modified_date": "2017-02-12T00:24:35Z",
    "user_id": "string"
  }
]
{}

FindEventsById

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/events/{id}
GET http://localhost:10010/V1/events/{id} HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/events/{id}',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/events/{id}', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/events/{id}', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/events/{id}', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/events/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /events/{id}

Retrieve a single event by id

Retrieve a single event by id

Parameters

Parameter In Type Required Description
id path string true ID of the event to get

Responses

Status Meaning Description
200 OK Event object response
default Default Error

Example responses

{
  "_key": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "type": "string",
  "event_start_date": "2017-02-12T00:24:35Z",
  "event_end_date": "2017-02-12T00:24:35Z",
  "door_open_time": "2017-02-12T00:24:35Z",
  "door_close_time": "2017-02-12T00:24:35Z",
  "total_capacity": 0,
  "purchase_limit": 0,
  "event_url": "string",
  "currency": "string",
  "tickets": [
    {
      "_key": "string",
      "name": "string",
      "description": "string",
      "ticket_url": "string",
      "order": 0,
      "price": 0,
      "maximum_available": 0,
      "availability": {
        "date_restrictions_status": true,
        "date_restrictions_Start_date": "string",
        "date_restrictions_end_date": "string",
        "date_restrictions_Start_time": "string",
        "date_restrictions_end_time": "string"
      },
      "modified_date": "2017-02-12T00:24:35Z",
      "user_id": "string"
    }
  ],
  "time_zone": "string",
  "artist_name": "string",
  "venue": {
    "name": "string",
    "address": "string",
    "city": "string",
    "province": "string",
    "country": "string",
    "zip": "string"
  },
  "scanner_code": "string",
  "modified_date": "2017-02-12T00:24:35Z",
  "user_id": "string"
}
{}

Event Tickets

Event Tickets methods provide access to information and operations relating to the event tickets.

FindEventTickets

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/events/{id}/tickets/
GET http://localhost:10010/V1/events/{id}/tickets/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/events/{id}/tickets/',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/events/{id}/tickets/', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/events/{id}/tickets/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/events/{id}/tickets/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/events/{id}/tickets/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /events/{id}/tickets/

Retrieve all tickets for an event

Retrieve all tickets for an event

Parameters

Parameter In Type Required Description
id path string true ID of the event to get

Responses

Status Meaning Description
200 OK Event Tickets object response
default Default Error

Example responses

[
  {
    "_key": "string",
    "name": "string",
    "description": "string",
    "ticket_url": "string",
    "order": 0,
    "price": 0,
    "maximum_available": 0,
    "availability": {
      "date_restrictions_status": true,
      "date_restrictions_Start_date": "string",
      "date_restrictions_end_date": "string",
      "date_restrictions_Start_time": "string",
      "date_restrictions_end_time": "string"
    },
    "modified_date": "2017-02-12T00:24:35Z",
    "user_id": "string"
  }
]
{}

CreateOrUpdateEventTicket

Code samples

# You can also use wget
curl -X post http://localhost:10010/V1/events/{id}/tickets/
POST http://localhost:10010/V1/events/{id}/tickets/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/events/{id}/tickets/',
    method: 'post',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/events/{id}/tickets/', { method: 'POST'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:10010/V1/events/{id}/tickets/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.post('http://localhost:10010/V1/events/{id}/tickets/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/events/{id}/tickets/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /events/{id}/tickets/

Create or Update a event ticket

Create or Update a event ticket

Parameters

Parameter In Type Required Description
event tickets body EventTicket true Add or update events details
id path string true ID of the event to get

Body parameter

{
  "_key": "string",
  "name": "string",
  "description": "string",
  "ticket_url": "string",
  "order": 0,
  "price": 0,
  "maximum_available": 0,
  "availability": {
    "date_restrictions_status": true,
    "date_restrictions_Start_date": "string",
    "date_restrictions_end_date": "string",
    "date_restrictions_Start_time": "string",
    "date_restrictions_end_time": "string"
  },
  "modified_date": "2017-02-12T00:24:35Z",
  "user_id": "string"
}

Responses

Status Meaning Description
200 OK Event Ticket response
default Default Error

Example responses

[
  {
    "_key": "string",
    "name": "string",
    "description": "string",
    "ticket_url": "string",
    "order": 0,
    "price": 0,
    "maximum_available": 0,
    "availability": {
      "date_restrictions_status": true,
      "date_restrictions_Start_date": "string",
      "date_restrictions_end_date": "string",
      "date_restrictions_Start_time": "string",
      "date_restrictions_end_time": "string"
    },
    "modified_date": "2017-02-12T00:24:35Z",
    "user_id": "string"
  }
]
{}

FindEventTicketsById

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/events/{id}/tickets/{tickets_id}/
GET http://localhost:10010/V1/events/{id}/tickets/{tickets_id}/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/events/{id}/tickets/{tickets_id}/',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/events/{id}/tickets/{tickets_id}/', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/events/{id}/tickets/{tickets_id}/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/events/{id}/tickets/{tickets_id}/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/events/{id}/tickets/{tickets_id}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /events/{id}/tickets/{tickets_id}/

Retrieve a single event ticket by id

Retrieve a single event ticket by id

Parameters

Parameter In Type Required Description
id path string true ID of the event to get
tickets_id path string true ID of the event ticket to get

Responses

Status Meaning Description
200 OK Event Ticket object response
default Default Error

Example responses

{
  "_key": "string",
  "name": "string",
  "description": "string",
  "ticket_url": "string",
  "order": 0,
  "price": 0,
  "maximum_available": 0,
  "availability": {
    "date_restrictions_status": true,
    "date_restrictions_Start_date": "string",
    "date_restrictions_end_date": "string",
    "date_restrictions_Start_time": "string",
    "date_restrictions_end_time": "string"
  },
  "modified_date": "2017-02-12T00:24:35Z",
  "user_id": "string"
}
{}

Tickets

Tickets methods provide access to information and operations relating to the tickets.

FindTickets

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/tickets/
GET http://localhost:10010/V1/tickets/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/tickets/',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/tickets/', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/tickets/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/tickets/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/tickets/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /tickets/

Retrieve all events

Retrieve all events

Responses

Status Meaning Description
200 OK Event object response
default Default Error

Example responses

[
  {
    "_key": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "type": "string",
    "event_start_date": "2017-02-12T00:24:35Z",
    "event_end_date": "2017-02-12T00:24:35Z",
    "door_open_time": "2017-02-12T00:24:35Z",
    "door_close_time": "2017-02-12T00:24:35Z",
    "total_capacity": 0,
    "purchase_limit": 0,
    "event_url": "string",
    "currency": "string",
    "tickets": [
      {
        "_key": "string",
        "name": "string",
        "description": "string",
        "ticket_url": "string",
        "order": 0,
        "price": 0,
        "maximum_available": 0,
        "availability": {
          "date_restrictions_status": true,
          "date_restrictions_Start_date": "string",
          "date_restrictions_end_date": "string",
          "date_restrictions_Start_time": "string",
          "date_restrictions_end_time": "string"
        },
        "modified_date": "2017-02-12T00:24:35Z",
        "user_id": "string"
      }
    ],
    "time_zone": "string",
    "artist_name": "string",
    "venue": {
      "name": "string",
      "address": "string",
      "city": "string",
      "province": "string",
      "country": "string",
      "zip": "string"
    },
    "scanner_code": "string",
    "modified_date": "2017-02-12T00:24:35Z",
    "user_id": "string"
  }
]
{}

CreateOrUpdateTicket

Code samples

# You can also use wget
curl -X post http://localhost:10010/V1/tickets/
POST http://localhost:10010/V1/tickets/ HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/tickets/',
    method: 'post',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/tickets/', { method: 'POST'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:10010/V1/tickets/', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.post('http://localhost:10010/V1/tickets/', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/tickets/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /tickets/

Create or Update a ticket

Create or Update a ticket

Parameters

Parameter In Type Required Description
ticket body Ticket true Add or update ticket details

Body parameter

{
  "_key": "string",
  "ticket_number": "string",
  "card_number": "string",
  "event_name": "string",
  "artist_name": "string",
  "customer_ref_id": "string",
  "venue": {
    "name": "string",
    "address": "string",
    "city": "string",
    "province": "string",
    "country": "string",
    "zip": "string"
  },
  "location": {
    "lat": "string",
    "lng": "string"
  },
  "ticket_category": 0,
  "ticket_price": 0,
  "date_purchased": 0,
  "door_open_time": "2017-02-12T00:24:35Z",
  "currency": "string",
  "subtotal_price": 0,
  "total_price": 0,
  "total_shipping": 0,
  "total_fees": 0,
  "total_tax": 0,
  "customer_email": "string",
  "modified_date": "2017-02-12T00:24:35Z",
  "user_id": "string"
}

Responses

Status Meaning Description
200 OK Ticket response
default Default Error

Example responses

[
  {
    "_key": "string",
    "ticket_number": "string",
    "card_number": "string",
    "event_name": "string",
    "artist_name": "string",
    "customer_ref_id": "string",
    "venue": {
      "name": "string",
      "address": "string",
      "city": "string",
      "province": "string",
      "country": "string",
      "zip": "string"
    },
    "location": {
      "lat": "string",
      "lng": "string"
    },
    "ticket_category": 0,
    "ticket_price": 0,
    "date_purchased": 0,
    "door_open_time": "2017-02-12T00:24:35Z",
    "currency": "string",
    "subtotal_price": 0,
    "total_price": 0,
    "total_shipping": 0,
    "total_fees": 0,
    "total_tax": 0,
    "customer_email": "string",
    "modified_date": "2017-02-12T00:24:35Z",
    "user_id": "string"
  }
]
{}

FindTicketsById

Code samples

# You can also use wget
curl -X get http://localhost:10010/V1/tickets/{id}
GET http://localhost:10010/V1/tickets/{id} HTTP/1.1
Host: localhost:10010
Content-Type: application/json
Accept: application/json
<script>
  $.ajax({
    url: 'http://localhost:10010/V1/tickets/{id}',
    method: 'get',
    success: function(data) {
      console.log(JSON.stringify(data));
    }
  })
</script>
const request = require('node-fetch');
fetch('http://localhost:10010/V1/tickets/{id}', { method: 'GET'})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:10010/V1/tickets/{id}', params:
  {
    # TODO
  }

p JSON.parse(result)
import requests

r = requests.get('http://localhost:10010/V1/tickets/{id}', params={
  # TODO
})

print r.json()
URL obj = new URL("http://localhost:10010/V1/tickets/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /tickets/{id}

Retrieve a single ticket by id

Retrieve a single ticket by id

Parameters

Parameter In Type Required Description
id path string true ID of the ticket to get

Responses

Status Meaning Description
200 OK Ticket object response
default Default Error

Example responses

{
  "_key": "string",
  "ticket_number": "string",
  "card_number": "string",
  "event_name": "string",
  "artist_name": "string",
  "customer_ref_id": "string",
  "venue": {
    "name": "string",
    "address": "string",
    "city": "string",
    "province": "string",
    "country": "string",
    "zip": "string"
  },
  "location": {
    "lat": "string",
    "lng": "string"
  },
  "ticket_category": 0,
  "ticket_price": 0,
  "date_purchased": 0,
  "door_open_time": "2017-02-12T00:24:35Z",
  "currency": "string",
  "subtotal_price": 0,
  "total_price": 0,
  "total_shipping": 0,
  "total_fees": 0,
  "total_tax": 0,
  "customer_email": "string",
  "modified_date": "2017-02-12T00:24:35Z",
  "user_id": "string"
}
{}

Errors

The Kittn API uses the following error codes:

Error Code Meaning
400 Bad Request – Your request sucks
401 Unauthorized – Your API key is wrong
403 Forbidden – The kitten requested is hidden for administrators only
404 Not Found – The specified kitten could not be found
405 Method Not Allowed – You tried to access a kitten with an invalid method
406 Not Acceptable – You requested a format that isn’t json
410 Gone – The kitten requested has been removed from our servers
418 I’m a teapot
429 Too Many Requests – You’re requesting too many kittens! Slow down!
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable – We’re temporarially offline for maintanance. Please try again later.

Webhooks

The webhooks are used in response to certain actions within Amplify. For example if an order is occuring, we will send a request to your webhook address asking for your system to process the order.

You can register your Webhook endpoint within the amplify API developer integration.

A list of the webhook types are:

General request structure

The general overall structure for the webhook request is as follows:

Example request

{
  "api_version": "v1",
  "created": "213435343",
  "data": {
    "object": {
    }
  },
  "id": "d35e34e333",
  "livemode": true,
  "object": "product",
  "type": "get_product",
  "user_id": "365345"
  }

The type attribute will change depending on the type of webhook being sent.

get_product

The structure of the create refund object is as follows:

Example request

{
  "product_ref_id": "389353",
  "integration_id": "32434543"
}

To respond to this request properly an example response is as follows:

Example response

{
  "_key": "string",
  "categories": "string",
  "currency": "string",
  "handle": "string",
  "image_source_url": "string",
  "image_thubnail": "string",
  "is_downloadable": true,
  "is_virtual": true,
  "keyword_locked": true,
  "out_stock": true,
  "price": 0,
  "price_compare": 0,
  "product_tags": [
    "string"
  ],
  "published_at": "2017-02-12T00:24:35Z",
  "ref_id": "string",
  "sku": "string",
  "source": "string",
  "tags": "string",
  "title": "string",
  "type": "string",
  "user_id": "string",
  "variants": [
    {
      "attributes": [
        {
          "name": "string",
          "option": "string",
          "slug": "string"
        }
      ],
      "created": "2017-02-12T00:24:35Z",
      "image_source_url": "string",
      "in_stock": true,
      "inventory_management": "string",
      "inventory_quantity": "string",
      "price": 0,
      "price_compare": 0,
      "product_ref_id": "string",
      "ref_id": "string",
      "sku": "string",
      "taxable": true,
      "title": "string",
      "updated": "2017-02-12T00:24:35Z",
      "visible": true,
      "weight": 0
    }
  ],
  "vendor": "string"
}

The product will be used to check for inventory numbers and other attributes as needed.

create_customer

The structure of the create refund object is as follows:

Example request

{
  "first_name": "John",
  "last_name": "Smith",
  "email": "[email protected]",
  "phone": "7786734536",
  "profile_id": "32434543",
  "shipping_address_1": "234 Long Lane",
  "shipping_address_2": "#7867",
  "shipping_city": "Vancouver",
  "shipping_state": "BC",
  "shipping_zip": "V6B 0Y1",
  "shipping_country": "CA",
  "integration_id": "32434543"
}

To respond to this request properly an example response is as follows:

Example response

{
  "ref_id": "string"
}

The reference id for amplify to store the new customer against.

create_order

The structure of the create a new order object is as follows:

Example request

{
  "type": "1234566",
  "variation_id": "completed",
  "first_name": "John",
  "last_name": "Smith",
  "email": "[email protected]",
  "phone": "7786734536",
  "shipping_rate": 49.98,
  "shipping_rate_code": 56.00,
  "tax_rate": 0,
  "total": 0,
  "quantity": "234324323",
  "product_ref_id": "234324323",
  "profile_ref_id": "234324323",
  "shipping_address_1": "234 Long Lane",
  "shipping_address_2": "#7867",
  "shipping_city": "Vancouver",
  "shipping_state": "BC",
  "shipping_zip": "V6B 0Y1",
  "shipping_country": "CA",
  "integration_id": "32434543"
}

To respond to this request properly an example response is as follows:

Example response

{
  "customer_ref_id": "1234566",
  "financial_status": "completed",
  "iqx_order": "2314324",
  "line_items": [
    {
      "attributes": [
        {
          "fulfillable_quantity": 2,
          "price": 29.99,
          "product_ref_id": 2137432,
          "ref_id": 1234324234,
          "sku": "123nds3"
        }
      ]
    }
  ],
  "processed_at": "2017-02-12T00:24:35Z",
  "ref_id": 123143242,
  "subtotal_price": 49.98,
  "total_price": 56.00,
  "total_shipping": 0,
  "total_tax": 0,
  "user_id": "234324323"
}

The reference id for amplify to store the new customer against.

get_shipping_class

The structure of the get shipping class object is as follows:

Example request

{
  "shipping_country": "CA",
  "shipping_state": "BC",
  "integration_id": "John",
  "price": "29.99",
  "weight": 0
}

To respond to this request properly an example response is as follows:

Example response

{
  "Standard Shipping": 10.00,
  "Express Shipping": 29.99,
}

A JSON object with addtibute keys as the shipping rate name and the value as the cost of the shipping.