API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

ENDPOINTS

Sandbox: https://wishlistdemo.iqmetrix.net/v1
Production: https://wishlist.iqmetrix.net/v1

RESOURCES

Wishlist

{
    "Id": 47,
    "CompanyId": 14146,
    "EntityId": 14192,
    "FirstName": "Yuri",
    "LastName": "Gagarin",
    "Email": "yuri.gagarin@example.com",
    "PhoneNumber": "555-555-5555",
    "SourceId": "4f107e22-945c-0a3b-b02b-774aae43539b",
    "CreatedBy": 2576,
    "DateCreatedUtc": "2016-12-09T14:40:46.2600999Z",
    "UpdatedBy": 2576,
    "UpdatedUtc": "2016-12-09T14:40:46.2600999Z",
    "Items": [
        {
            "Id": 41,
            "CatalogItemId": "87ff38c2-94c6-20b1-9afc-89464ab74a66",
            "Slug": "M2307",
            "Quantity": 4,
            "DisplayPrice": 405.9
        }
    ]
}
Name Description
Id (Integer) Identifier
CompanyId (Integer) Identifier for a Company
EntityId (Integer) Identifier for a CompanyTreeNode
FirstName (String) First name
LastName (String) Last name
Email (String) Email
PhoneNumber (String) Phone number
SourceId (GUID) Originating source of the wishlist
CreatedBy (Integer) Identifier of the User that created the Wishlist
DateCreatedUtc (DateTime) Date created, in UTC
UpdatedBy (Integer) Identifier of the User that last updated the Wishlist
UpdatedUtc (DateTime) Last updated date, in UTC
Items (Array[WishlistItem]) Items

WishlistItem

{
    "Id": 41,
    "CatalogItemId": "87ff38c2-94c6-20b1-9afc-89464ab74a66",
    "Slug": "M2307",
    "Quantity": 4,
    "DisplayPrice": 405.9
}
Name Description
Id (Integer) Identifier
CatalogItemId (GUID) Identifier for a CatalogItem
Slug (String) Slug
Quantity (Integer) Quantity
DisplayPrice (Decimal) DisplayPrice

REQUESTS

GET a Wishlist

One of FirstName, LastName, Email or PhoneNumber is required.

Request

POST /companies({CompanyId})/entities({CompanyTreeNodeId})/wishlists

Example Request

POST /companies(14146)/entities(14192)/wishlists
curl -X POST "https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists" -d '{
    "FirstName": "Yuri",
    "LastName": "Gagarin",
    "Email": "yuri.gagarin@example.com",
    "PhoneNumber": "555-555-5555",
    "SourceId": "4f107e22-945c-0a3b-b02b-774aae43539b",
    "Items": [
        {
            "CatalogItemId": "87ff38c2-94c6-20b1-9afc-89464ab74a66",
            "Slug": "M2307",
            "Quantity": 4,
            "DisplayPrice": 405.9
        }
    ]
}'
static IRestResponse GettingAWishlist()
{
    var client = new RestClient("https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists");
    var request = new RestRequest(Method.POST);
     

     request.AddParameter("application/json", "{\"FirstName\":\"Yuri\",\"LastName\":\"Gagarin\",\"Email\":\"yuri.gagarin@example.com\",\"PhoneNumber\":\"555-555-5555\",\"SourceId\":\"4f107e22-945c-0a3b-b02b-774aae43539b\",\"Items\":[{\"CatalogItemId\":\"87ff38c2-94c6-20b1-9afc-89464ab74a66\",\"Slug\":\"M2307\",\"Quantity\":4,\"DisplayPrice\":405.9}]}", ParameterType.RequestBody);

    return client.Execute(request);
}
import org.apache.http.entity.StringEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingAWishlist() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists");
     
    StringEntity body = new StringEntity("{\"FirstName\":\"Yuri\",\"LastName\":\"Gagarin\",\"Email\":\"yuri.gagarin@example.com\",\"PhoneNumber\":\"555-555-5555\",\"SourceId\":\"4f107e22-945c-0a3b-b02b-774aae43539b\",\"Items\":[{\"CatalogItemId\":\"87ff38c2-94c6-20b1-9afc-89464ab74a66\",\"Slug\":\"M2307\",\"Quantity\":4,\"DisplayPrice\":405.9}]}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"FirstName\":\"Yuri\",\"LastName\":\"Gagarin\",\"Email\":\"yuri.gagarin@example.com\",\"PhoneNumber\":\"555-555-5555\",\"SourceId\":\"4f107e22-945c-0a3b-b02b-774aae43539b\",\"Items\":[{\"CatalogItemId\":\"87ff38c2-94c6-20b1-9afc-89464ab74a66\",\"Slug\":\"M2307\",\"Quantity\":4,\"DisplayPrice\":405.9}]}";

response = RestClient.post 'https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists', body 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 201 Content-Type: application/json
{
    "Id": 47,
    "CompanyId": 14146,
    "EntityId": 14192,
    "FirstName": "Yuri",
    "LastName": "Gagarin",
    "Email": "yuri.gagarin@example.com",
    "PhoneNumber": "555-555-5555",
    "SourceId": "4f107e22-945c-0a3b-b02b-774aae43539b",
    "CreatedBy": 2576,
    "DateCreatedUtc": "2016-12-09T14:40:46.2600999Z",
    "UpdatedBy": 2576,
    "UpdatedUtc": "2016-12-09T14:40:46.2600999Z",
    "Items": [
        {
            "Id": 41,
            "CatalogItemId": "87ff38c2-94c6-20b1-9afc-89464ab74a66",
            "Slug": "M2307",
            "Quantity": 4,
            "DisplayPrice": 405.9
        }
    ]
}

Wishlist

GET a Wishlist

Request

GET /companies({CompanyId})/entities({CompanyTreeNodeId})/wishlists

Example Request

GET /companies(14146)/entities(14192)/wishlists
curl -X GET "https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists"
static IRestResponse GettingAWishlist()
{
    var client = new RestClient("https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists");
    var request = new RestRequest(Method.GET);
     

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingAWishlist() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists");
     
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists' 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": 47,
    "CompanyId": 14146,
    "EntityId": 14192,
    "FirstName": "Yuri",
    "LastName": "Gagarin",
    "Email": "yuri.gagarin@example.com",
    "PhoneNumber": "555-555-5555",
    "SourceId": "4f107e22-945c-0a3b-b02b-774aae43539b",
    "CreatedBy": 2576,
    "DateCreatedUtc": "2016-12-09T14:40:46.2600999Z",
    "UpdatedBy": 2576,
    "UpdatedUtc": "2016-12-09T14:40:46.2600999Z",
    "Items": [
        {
            "Id": 41,
            "CatalogItemId": "87ff38c2-94c6-20b1-9afc-89464ab74a66",
            "Slug": "M2307",
            "Quantity": 4,
            "DisplayPrice": 405.9
        }
    ]
}

Wishlist

GET a Wishlist

Request

GET /companies({CompanyId})/entities({CompanyTreeNodeId})/wishlists({WishlistId})

Example Request

GET /companies(14146)/entities(14192)/wishlists(33)
curl -X GET "https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)"
static IRestResponse GettingAWishlist()
{
    var client = new RestClient("https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)");
    var request = new RestRequest(Method.GET);
     

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingAWishlist() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)");
     
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)' 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": 47,
    "CompanyId": 14146,
    "EntityId": 14192,
    "FirstName": "Yuri",
    "LastName": "Gagarin",
    "Email": "yuri.gagarin@example.com",
    "PhoneNumber": "555-555-5555",
    "SourceId": "4f107e22-945c-0a3b-b02b-774aae43539b",
    "CreatedBy": 2576,
    "DateCreatedUtc": "2016-12-09T14:40:46.2600999Z",
    "UpdatedBy": 2576,
    "UpdatedUtc": "2016-12-09T14:40:46.2600999Z",
    "Items": [
        {
            "Id": 41,
            "CatalogItemId": "87ff38c2-94c6-20b1-9afc-89464ab74a66",
            "Slug": "M2307",
            "Quantity": 4,
            "DisplayPrice": 405.9
        }
    ]
}

Wishlist

POST an Item to a Wishlist

Request

PUT /companies({CompanyId})/entities({CompanyTreeNodeId})/wishlists({WishlistId})/addItem

Example Request

PUT /companies(14146)/entities(14192)/wishlists(33)/addItem
curl -X PUT "https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)/addItem" -d '{
    "Id": 41,
    "CatalogItemId": "87ff38c2-94c6-20b1-9afc-89464ab74a66",
    "Slug": "M2307",
    "Quantity": 4,
    "DisplayPrice": 405.9
}'
static IRestResponse AddingAnItemToAWishlist()
{
    var client = new RestClient("https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)/addItem");
    var request = new RestRequest(Method.PUT);
     

     request.AddParameter("application/json", "{\"Id\":41,\"CatalogItemId\":\"87ff38c2-94c6-20b1-9afc-89464ab74a66\",\"Slug\":\"M2307\",\"Quantity\":4,\"DisplayPrice\":405.9}", ParameterType.RequestBody);

    return client.Execute(request);
}
import org.apache.http.entity.StringEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse AddingAnItemToAWishlist() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPut request = new HttpPut("https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)/addItem");
     
    StringEntity body = new StringEntity("{\"Id\":41,\"CatalogItemId\":\"87ff38c2-94c6-20b1-9afc-89464ab74a66\",\"Slug\":\"M2307\",\"Quantity\":4,\"DisplayPrice\":405.9}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"Id\":41,\"CatalogItemId\":\"87ff38c2-94c6-20b1-9afc-89464ab74a66\",\"Slug\":\"M2307\",\"Quantity\":4,\"DisplayPrice\":405.9}";

response = RestClient.put 'https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)/addItem', body 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": 47,
    "CompanyId": 14146,
    "EntityId": 14192,
    "FirstName": "Yuri",
    "LastName": "Gagarin",
    "Email": "yuri.gagarin@example.com",
    "PhoneNumber": "555-555-5555",
    "SourceId": "4f107e22-945c-0a3b-b02b-774aae43539b",
    "CreatedBy": 2576,
    "DateCreatedUtc": "2016-12-09T14:40:46.2600999Z",
    "UpdatedBy": 2576,
    "UpdatedUtc": "2016-12-09T14:40:46.2600999Z",
    "Items": [
        {
            "Id": 41,
            "CatalogItemId": "87ff38c2-94c6-20b1-9afc-89464ab74a66",
            "Slug": "M2307",
            "Quantity": 4,
            "DisplayPrice": 405.9
        }
    ]
}

Wishlist

DELETE an Item from a Wishlist

Request

PUT /companies({CompanyId})/entities({CompanyTreeNodeId})/wishlists({WishlistId})/removeItem

Example Request

PUT /companies(14146)/entities(14192)/wishlists(33)/removeItem
curl -X PUT "https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)/removeItem" -d '{
    "Id": 41,
    "CatalogItemId": "87ff38c2-94c6-20b1-9afc-89464ab74a66",
    "Slug": "M2307",
    "Quantity": 4,
    "DisplayPrice": 405.9
}'
static IRestResponse RemovingAnItemFromAWishlist()
{
    var client = new RestClient("https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)/removeItem");
    var request = new RestRequest(Method.PUT);
     

     request.AddParameter("application/json", "{\"Id\":41,\"CatalogItemId\":\"87ff38c2-94c6-20b1-9afc-89464ab74a66\",\"Slug\":\"M2307\",\"Quantity\":4,\"DisplayPrice\":405.9}", ParameterType.RequestBody);

    return client.Execute(request);
}
import org.apache.http.entity.StringEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse RemovingAnItemFromAWishlist() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPut request = new HttpPut("https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)/removeItem");
     
    StringEntity body = new StringEntity("{\"Id\":41,\"CatalogItemId\":\"87ff38c2-94c6-20b1-9afc-89464ab74a66\",\"Slug\":\"M2307\",\"Quantity\":4,\"DisplayPrice\":405.9}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"Id\":41,\"CatalogItemId\":\"87ff38c2-94c6-20b1-9afc-89464ab74a66\",\"Slug\":\"M2307\",\"Quantity\":4,\"DisplayPrice\":405.9}";

response = RestClient.put 'https://wishlistdemo.iqmetrix.net/v1/companies(14146)/entities(14192)/wishlists(33)/removeItem', body 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": 47,
    "CompanyId": 14146,
    "EntityId": 14192,
    "FirstName": "Yuri",
    "LastName": "Gagarin",
    "Email": "yuri.gagarin@example.com",
    "PhoneNumber": "555-555-5555",
    "SourceId": "4f107e22-945c-0a3b-b02b-774aae43539b",
    "CreatedBy": 2576,
    "DateCreatedUtc": "2016-12-09T14:40:46.2600999Z",
    "UpdatedBy": 2576,
    "UpdatedUtc": "2016-12-09T14:40:46.2600999Z",
    "Items": [
        {
            "Id": 41,
            "CatalogItemId": "87ff38c2-94c6-20b1-9afc-89464ab74a66",
            "Slug": "M2307",
            "Quantity": 4,
            "DisplayPrice": 405.9
        }
    ]
}

Wishlist

Was this page helpful?