API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

Suppliers have the ability to configure availability of products.

ENDPOINTS

Sandbox: https://dropshipdemo.iqmetrix.net/v1
Production: https://dropship.iqmetrix.net/v1

RESOURCES

Availability

{
    "Id": "c2a97823-196b-4b3e-891a-ba01665797e4",
    "Products": [
        {
            "IsAvailable": true,
            "Sku": "9101AGAP6",
            "Quantity": 10
        }
    ]
}
Name Description
Id (GUID) Unique identifier
Products (Array[object]) Products for the Availability Feed
Products.IsAvailable (Boolean) A flag to indicate if the Product is Available
Products.Sku (String) Vendor SKU
Products.Quantity (Integer) Product quantity

REQUESTS

Configuring Product Availability

Request

POST /Suppliers({SupplierId})/Availability

Example Request

POST /Suppliers(14107)/Availability
Authorization: Bearer (Access Token)
Accept: application/json
Content-Type: application/json

{
    "Products": [
        {
            "IsAvailable": true,
            "Sku": "9101AGAP6",
            "Quantity": 10
        }
    ]
}
curl -X POST "https://dropshipdemo.iqmetrix.net/v1/Suppliers(14107)/Availability" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
    "Products": [
        {
            "IsAvailable": true,
            "Sku": "9101AGAP6",
            "Quantity": 10
        }
    ]
}'
static IRestResponse ConfiguringProductAvailability()
{
    var client = new RestClient("https://dropshipdemo.iqmetrix.net/v1/Suppliers(14107)/Availability");
    var request = new RestRequest(Method.POST);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 
    request.AddHeader("Content-Type", "application/json"); 

     request.AddParameter("application/json", "{\"Products\":[{\"IsAvailable\":true,\"Sku\":\"9101AGAP6\",\"Quantity\":10}]}", 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 ConfiguringProductAvailability() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://dropshipdemo.iqmetrix.net/v1/Suppliers(14107)/Availability");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"Products\":[{\"IsAvailable\":true,\"Sku\":\"9101AGAP6\",\"Quantity\":10}]}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"Products\":[{\"IsAvailable\":true,\"Sku\":\"9101AGAP6\",\"Quantity\":10}]}";

response = RestClient.post 'https://dropshipdemo.iqmetrix.net/v1/Suppliers(14107)/Availability', body, {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
     :'Content-Type' => 'application/json',
    } 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 202 Content-Type: application/json
{
    "Id": "c2a97823-196b-4b3e-891a-ba01665797e4",
    "Products": [
        {
            "IsAvailable": true,
            "Sku": "9101AGAP6",
            "Quantity": 10
        }
    ]
}

Availability

FAQ

How is availability handled?

Availability is cached at iQmetrix before being displayed in RQ. Availability on a per supplier level and not at the retailer level.

During a shipping options query, you should ensure that your API will reject the SKU should it not be available (e.g. throw an error).

For example, attempt to put a threshold of 100 products set for dropship and sell the remaining items by other means. Any items that have been removed from list would then no longer be dropshippable.

ERRORS

Error Code Message How to Resolve
HTTP 400 Cannot find supplier identifier in the uri Occurs when entering an incorrect SupplierId in the uri
Was this page helpful?