API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

The Order Management API allows you to get the status of Dropship Orders.

ENDPOINTS

Sandbox: https://ordermanagementreportingdemo.iqmetrix.net/v1
Production: https://ordermanagementreporting.iqmetrix.net/v1

RESOURCES

Column

{
    "name": "Location",
    "key": "locationId"
}
Name Description  
name (String) Column name  
key (String) Field name  
type (Integer) For internal use only  
formatType (String) For internal use only  
isViewable (String) For internal use only  

ReportOrder

{
    "_id": "58cad41cdc0db43a61eec9e3",
    "invoiceNumber": "INKG5-2498",
    "companyId": 14146,
    "locationId": 14202,
    "locationName": "Dufferin Mall",
    "customerName": "John Smith",
    "shippingEntityId": "0",
    "shippingEntityName": "Customer",
    "statusId": "0",
    "statusName": "Pending",
    "createdUtc": "2017-03-16T18:06:16.7950000Z"
}
Name Description
_id (String) Unique system generated identifier
invoiceNumber (String) Invoice Number / PO Reference
companyId (Integer) Identifier for a Company
locationId (Integer) Identifier for a Location
locationName (String) Location name
customerName (String) Customer’s first and last name
shippingEntityId (String) Identifier of a Location for ship to store, or 0 if shipped to customer
shippingEntityName (String) Name of a Location for ship to store or Customer if ship to customer
statusId (String) Order status, Pending (0) or Completed (1)
statusName (String) Order status, Pending or Completed
createdUtc (DateTime) Order created date, in UTC

OrderDetails

{
    "id": "58c6f4bddc0db43a61ee98b5",
    "invoiceNumber": "INKG5-2451",
    "companyId": 14146,
    "companyName": "Globex",
    "locationId": 14202,
    "locationName": "Dufferin Mall",
    "customerName": "John Smith",
    "shipToStore": false,
    "shippingEntityId": "0",
    "shippingEntityName": "Customer",
    "statusId": "0",
    "statusName": "Pending",
    "billToAddress": {
        "crmId": "d2631c9d-0303-14b8-b328-16ac5e409fb2",
        "crmAddressId": "a5828b6c-13be-b07b-bebd-1060c72828fd",
        "customerName": "John Smith",
        "businessName": "",
        "streetAddress1": "349 W. Narwhal Lane",
        "streetAddress2": "Suite 400",
        "city": "Cypress",
        "postalCode": 55555,
        "region": "Texas",
        "regionCode": "TX",
        "country": "United States",
        "countryCode": "US",
        "email": "",
        "phone": "(555) 555-5556"
    },
    "shipToAddress": {
        "crmId": "d2631c9d-0303-14b8-b328-16ac5e409fb2",
        "crmAddressId": "a5828b6c-13be-b07b-bebd-1060c72828fd",
        "customerName": "John Smith",
        "businessName": "",
        "streetAddress1": "349 W. Narwhal Lane",
        "streetAddress2": "Suite 400",
        "city": "Cypress",
        "postalCode": 55555,
        "region": "Texas",
        "regionCode": "TX",
        "country": "United States",
        "countryCode": "US",
        "email": "",
        "phone": "(555) 555-5556"
    },
    "dropshipOrderItems": [
        {
            "dropshipOrderId": "9dd08bfc-24a0-99ed-64c4-8b5602402f91",
            "supplierId": 81553,
            "supplierName": "NOZAMA Inc.",
            "catalogItemId": "788b732b-16bd-9c19-7954-4e0eec524f65",
            "productName": "Motorola Droid Ultra Aegis Case - Trident Green",
            "supplierSku": "EKg-18-IAY",
            "quantity": 1,
            "sellingPrice": 34.95,
            "statusId": "0",
            "statusName": "Pending Supplier",
            "trackingNumber": "",
            "shippingProvider": "",
            "supplierMessage": "",
            "updatedUtc": "2017-03-13T19:36:26.2620000Z"
        }
    ],
    "createdUtc": "2017-03-16T18:06:16.7950000Z",
    "updatedUtc": "2017-03-13T19:36:26.2620000Z"
}
Name Description
id (String) Unique identifier
invoiceNumber (String) Invoice number/PO Reference
companyId (Integer) Company identifier
companyName (String) Company name
locationId (Integer) Identifier for a Location
locationName (String) Location name
customerName (String) Customer’s first and last name
shipToStore (Integer) A flag to indicate if the order will be shipped to store (true) or customer (false)
shippingEntityId (String) Identifier of a Location for ship to store, or 0 if shipped to customer
shippingEntityName (String) Name of a Location for ship to store or Customer if ship to customer
statusId (String) Order status, Pending (0) or Completed (1)
statusName (String) Order status, Pending or Completed
billToAddress (OrderAddress) Bill to address
shipToAddress (OrderAddress) Ship to address
dropshipOrderItems (DropshipOrderItem) Dropship items
createdUtc (DateTime) Order created date, in UTC
updatedUtc (DateTime) Date order was last updated, in UTC

DropshipOrderItem

{
    "dropshipOrderId": "9dd08bfc-24a0-99ed-64c4-8b5602402f91",
    "supplierId": 81553,
    "supplierName": "NOZAMA Inc.",
    "catalogItemId": "788b732b-16bd-9c19-7954-4e0eec524f65",
    "productName": "Motorola Droid Ultra Aegis Case - Trident Green",
    "supplierSku": "EKg-18-IAY",
    "quantity": 1,
    "sellingPrice": 34.95,
    "statusId": "0",
    "statusName": "Pending Supplier",
    "trackingNumber": "",
    "shippingProvider": "",
    "supplierMessage": "",
    "updatedUtc": "2017-03-13T19:36:26.2620000Z"
}
Name Description
dropshipOrderId (GUID) Unique identifier
supplierId (Integer) Identifier for a Supplier
supplierName (String) Supplier name
catalogItemId (GUID) Identifier for a CatalogItem
productName (String) Product name
supplierSku (String) Supplier SKU
quantity (Integer) Quantity
sellingPrice (Integer) Selling price
statusId (String) Status, see DropshipItemStatus for a list of acceptable values
statusName (String) Status name, see statusId
trackingNumber (String) Tracking number
shippingProvider (String) Shipping provider
supplierMessage (String) Message from supplier
updatedUtc (DateTime) Date item was last updated in UTC

OrderAddress

{
    "crmId": "d2631c9d-0303-14b8-b328-16ac5e409fb2",
    "crmAddressId": "a5828b6c-13be-b07b-bebd-1060c72828fd",
    "customerName": "John Smith",
    "businessName": "",
    "streetAddress1": "349 W. Narwhal Lane",
    "streetAddress2": "Suite 400",
    "city": "Cypress",
    "postalCode": 55555,
    "region": "Texas",
    "regionCode": "TX",
    "country": "United States",
    "countryCode": "US",
    "email": "",
    "phone": "(555) 555-5556"
}
Name Description
crmId (GUID) Identifier for a Customer
crmAddressId (GUID) Identifier for a Address
customerName (String) Customer first and last name
businessName (String) Business’s display name if available
streetAddress1 (String) Address 1
streetAddress2 (String) Address 2
city (String) City
postalCode (Integer) Postal or Zip code
region (String) Province or State
regionCode (String) {Province or State Code
country (String) Country
countryCode (String) Country code
email (String) Email
phone (String) Phone number

ENUMERATIONS

DropshipItemStatus

Id Status
0 Pending Supplier
1 Ordered
2 Shipped
3 Back Ordered
4 Error
5 NotAvailable
6 PartiallyShipped
7 Cancelled
8 Other

REQUESTS

GET A List of Orders

Request

GET /Reports/OrderList/report?filter={filter}&page={page}&pageSize={pageSize}&sortBy={sortBy}&sortOrder={sortOrder}

Example Request

GET /Reports/OrderList/report?filter=companyId eq 14146&page=1&pageSize=20&sortBy=customerName&sortOrder=desc
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://ordermanagementreportingdemo.iqmetrix.net/v1/Reports/OrderList/report?filter=companyId eq 14146&page=1&pageSize=20&sortBy=customerName&sortOrder=desc" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingAListOfOrders()
{
    var client = new RestClient("https://ordermanagementreportingdemo.iqmetrix.net/v1/Reports/OrderList/report?filter=companyId eq 14146&page=1&pageSize=20&sortBy=customerName&sortOrder=desc");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    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 GettingAListOfOrders() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://ordermanagementreportingdemo.iqmetrix.net/v1/Reports/OrderList/report?filter=companyId eq 14146&page=1&pageSize=20&sortBy=customerName&sortOrder=desc");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://ordermanagementreportingdemo.iqmetrix.net/v1/Reports/OrderList/report?filter=companyId eq 14146&page=1&pageSize=20&sortBy=customerName&sortOrder=desc', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "definition": {
        "id": "OrderList",
        "name": "Order List Report",
        "ownEntityPermission": "ViewOrderManagement",
        "anyEntityPermission": "ViewAllOrderManagement",
        "collection": "Order",
        "description": "View list of Platform orders.",
        "columns": [
            {
                "name": "Location",
                "key": "locationId"
            }
        ]
    },
    "rows": [
        {
            "_id": "58cad41cdc0db43a61eec9e3",
            "invoiceNumber": "INKG5-2498",
            "companyId": 14146,
            "locationId": 14202,
            "locationName": "Dufferin Mall",
            "customerName": "John Smith",
            "shippingEntityId": "0",
            "shippingEntityName": "Customer",
            "statusId": "0",
            "statusName": "Pending",
            "createdUtc": "2017-03-16T18:06:16.7950000Z"
        }
    ],
    "totalRecords": 6
}

GET Order Details

Request

GET /Companies({CompanyId})/OrderDetails({OrderDetailId})

Example Request

GET /Companies(14146)/OrderDetails(58c6f4bddc0db43a61ee98b5)
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://ordermanagementreportingdemo.iqmetrix.net/v1/Companies(14146)/OrderDetails(58c6f4bddc0db43a61ee98b5)" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingOrderDetails()
{
    var client = new RestClient("https://ordermanagementreportingdemo.iqmetrix.net/v1/Companies(14146)/OrderDetails(58c6f4bddc0db43a61ee98b5)");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    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 GettingOrderDetails() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://ordermanagementreportingdemo.iqmetrix.net/v1/Companies(14146)/OrderDetails(58c6f4bddc0db43a61ee98b5)");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://ordermanagementreportingdemo.iqmetrix.net/v1/Companies(14146)/OrderDetails(58c6f4bddc0db43a61ee98b5)', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "id": "58c6f4bddc0db43a61ee98b5",
    "invoiceNumber": "INKG5-2451",
    "companyId": 14146,
    "companyName": "Globex",
    "locationId": 14202,
    "locationName": "Dufferin Mall",
    "customerName": "John Smith",
    "shipToStore": false,
    "shippingEntityId": "0",
    "shippingEntityName": "Customer",
    "statusId": "0",
    "statusName": "Pending",
    "billToAddress": {
        "crmId": "d2631c9d-0303-14b8-b328-16ac5e409fb2",
        "crmAddressId": "a5828b6c-13be-b07b-bebd-1060c72828fd",
        "customerName": "John Smith",
        "businessName": "",
        "streetAddress1": "349 W. Narwhal Lane",
        "streetAddress2": "Suite 400",
        "city": "Cypress",
        "postalCode": 55555,
        "region": "Texas",
        "regionCode": "TX",
        "country": "United States",
        "countryCode": "US",
        "email": "",
        "phone": "(555) 555-5556"
    },
    "shipToAddress": {
        "crmId": "d2631c9d-0303-14b8-b328-16ac5e409fb2",
        "crmAddressId": "a5828b6c-13be-b07b-bebd-1060c72828fd",
        "customerName": "John Smith",
        "businessName": "",
        "streetAddress1": "349 W. Narwhal Lane",
        "streetAddress2": "Suite 400",
        "city": "Cypress",
        "postalCode": 55555,
        "region": "Texas",
        "regionCode": "TX",
        "country": "United States",
        "countryCode": "US",
        "email": "",
        "phone": "(555) 555-5556"
    },
    "dropshipOrderItems": [
        {
            "dropshipOrderId": "9dd08bfc-24a0-99ed-64c4-8b5602402f91",
            "supplierId": 81553,
            "supplierName": "NOZAMA Inc.",
            "catalogItemId": "788b732b-16bd-9c19-7954-4e0eec524f65",
            "productName": "Motorola Droid Ultra Aegis Case - Trident Green",
            "supplierSku": "EKg-18-IAY",
            "quantity": 1,
            "sellingPrice": 34.95,
            "statusId": "0",
            "statusName": "Pending Supplier",
            "trackingNumber": "",
            "shippingProvider": "",
            "supplierMessage": "",
            "updatedUtc": "2017-03-13T19:36:26.2620000Z"
        }
    ],
    "createdUtc": "2017-03-16T18:06:16.7950000Z",
    "updatedUtc": "2017-03-13T19:36:26.2620000Z"
}

OrderDetails

SEARCHING

The Order Management API supports searching/filtering in the request Getting A List of Orders using the filter URI parameter.

Available Filters

Any property in the ReportOrder resource can be used as a filter.

See the table below for available filter options and the syntax of using each option.

Keyword Filter Description Examples
eq Property is equal to value companyId eq 14146
locationName eq 'Dufferin Mall'
like Property contains value invoiceNumber like 'IN'
locationName like 'Duff'

Combining Filters

Filters can be combined using the keyword and as shown below.

Example
companyId eq 14146 and locationName like 'Duff'

ERRORS

Error Code Description Reason
HTTP 400 Bad Request Ensure the filter provided is valid
HTTP 403 Forbidden Contact support to check permissions for your user account
HTTP 500 Internal Server Error Ensure CompanyId is in filter
Was this page helpful?