API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

To create a Pending Dropship Order, follow the steps below,

  1. Call Create a Pending Dropship Order for each supplier. If there is a single order being fulfilled by many dropship suppliers, there should be multiple Pending Dropship Orders Created
  2. ServiceOriginOrderId should be unique on the parent order. For situations where a single order contain items for multiple suppliers, there would be a pending order created for each supplier with the same ServiceOriginOrderId, which should be unique to your system
  3. Once created, the Pending Dropship Order will have Status Created and will go through validation. Once validation is complete, Status will change to Validated or Rejected. We recommend calling Get a Pending Dropship Order at a set interval until validation is complete
  4. If Rejected, the FailedValidationReasons array will contain the reason. You will need to create new Pending Dropship Order(s) with new ServiceOriginOrderId values
  5. If Validated, call Complete Pending Dropship Orders to submit the dropship order(s) and notify the supplier(s)

ENDPOINTS

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

RESOURCES

PendingOrder

{
    "Id": "a137c49d-744a-6f4b-7944-0ca377cdcbe6",
    "SupplierId": 81553,
    "RetailerId": 14146,
    "LocationId": 15726,
    "ShippingCustomerCrmId": "c080322b-9330-866d-feb4-a7aa6bb014e4",
    "ShippingCustomerAddressCrmId": "e4a85988-3173-7dfa-85e5-032e29233228",
    "BillingCustomerCrmId": "c5b65166-4627-95a7-c88d-c428e274d776",
    "BillingCustomerAddressCrmId": "c6a84bfb-78a6-3d17-4086-c794eec8088b",
    "ServiceOriginName": "Order",
    "ServiceOriginOrderId": "26eeb937-a574-5b5e-5bb3-2d78a1563b38",
    "ClientOriginName": "POS",
    "PrintableId": "7B1Q84D",
    "ShippingMethod": 1,
    "ShippingMethodName": "USPS",
    "ShippingCost": 19.99,
    "ShippingEntityId": 25452,
    "Items": [
        {
            "CatalogId": "719dfd4f-5123-6543-b259-22ab4f4e19b7",
            "Sku": "MAG484-BLK",
            "Quantity": 1,
            "SellingPrice": 11.95,
            "Description": "Apple Iphone 6 case - Black",
            "Cost": 19.99
        }
    ],
    "Status": "Validated",
    "CreatedDate": "2017-04-10T19:03:20.35",
    "FailedValidationReasons": [
        {
            "ReasonCode": "SUPPLIER_NOT_FOUND",
            "Fields": [
                {
                    "{FieldName}": "RetailerId",
                    "FailureResponse": "Entity Not Found"
                }
            ]
        }
    ],
    "IqReferenceId": "CROWFIN42409"
}
Name Description  
Id (GUID) Unique Identifier  
SupplierId (Integer) Identifier for a Supplier  
RetailerId (Integer) Identifier for a Company  
LocationId (Integer) Identifier for a Location in the Company  
ShippingCustomerCrmId (GUID) Identifier of a Customer  
ShippingCustomerAddressCrmId (GUID) Identifier of a Customer Address  
BillingCustomerCrmId (GUID) Identifier of a Customer used for billing  
BillingCustomerAddressCrmId (GUID) Identifier of a Customer Address  
ServiceOriginName (String) Name of service that initiated order  
ServiceOriginOrderId (GUID) Id that represents the original order from the source service  
ClientOriginName (String) Name of the client that initiated creation  
PrintableId (String) An identifier that can used to print on invoices  
ShippingMethod (Integer) Identifier for a shipping option  
ShippingMethodName (String) Name for a shipping option  
ShippingCost (Decimal) Cost of shipping option  
ShippingEntityId (Integer) Identifier of shipping entity where the order should be shipped  
Items (Array[PendingOrderItem]) Dropship order items  
Status (String) Status of order, see OrderStatus  
CreatedDate (DateTime) Created date  
FailedValidationReasons (Array[object]) Validation failure reasons  
FailedValidationReasons.ReasonCode (String) Failure Reason, see ReasonCodes  
FailedValidationReasons.Fields (Array[object]) Field(s) that resulted in failure  
FailedValidationReasons.Fields.{FieldName} (String) Field name  
FailedValidationReasons.Fields.FailureResponse (String) Reason for failure  
IqReferenceId (String) Customer invoice number, unique for each order  
InvoiceServiceId (String) For internal use only  

PendingOrderItem

{
    "CatalogId": "719dfd4f-5123-6543-b259-22ab4f4e19b7",
    "Sku": "MAG484-BLK",
    "Quantity": 1,
    "SellingPrice": 11.95,
    "Description": "Apple Iphone 6 case - Black",
    "Cost": 19.99
}
Name Description
CatalogId (GUID) Identifier for a CatalogItem
Sku (String) SKU
Quantity (Integer) Quantity ordered
SellingPrice (Decimal) Selling Price of product
Description (String) Description of product
Cost (Decimal) Cost of product

ENUMERATIONS

OrderStatus

Name
New
Validated
Rejected
Completed

ReasonCodes

Reason Code Description Fields
COMPANY_ID_AND_RETAILER_ID_MUST_MATCH CompanyId in URL must match RetailerId in payload { CompanyId: 123, RetailerId: 124 }
MUST_PROVIDE_SERVICE_ORIGIN_NAME ServiceOriginName is required { ServiceOriginName: null }
MUST_PROVIDE_SERVICE_ORIGIN_ORDER_ID ServiceOriginOrderId is required { ServiceOriginOrderId: ""}
MUST_PROVIDE_CLIENT_ORIGIN_NAME ClientOriginName is required { ClientOriginName: ""}
MUST_PROVIDE_RETAILER_ID RetailerId is required { RetailerId: 0 }
MUST_PROVIDE_LOCATION_ID LocationId is required { LocationId: 0 }
MUST_PROVIDE_SHIPPING_METHOD ShippingMethod is required { ShippingMethod: "" }
MUST_PROVIDE_SUPPLIER_ID SupplierId is required { SupplierId: 0 }
MUST_PROVIDE_BILLING_CUSTOMER BillingCustomerCrmId is required { BillingCustomerCrmId: "00000000-0000-0000-0000-000000000000" }
PRINTABLE_ID_TOO_LONG PrintableId has a max length of 20 characters { PrintableId: "ABCDEFGHIJKLMNOPQRSTUVWXYZ", MaxLength: 20 }
MUST_PROVIDE_SHIPPING_LOCATION Must provide either ShippingEntityId or ShippingCustomerAddressCrmId { ShippingEntityId: 0, ShippingCustomerAddressCrmId: "00000000-0000-0000-0000-000000000000" }
MUST_PROVIDE_SHIPPING_CUSTOMER ShippingCustomerCrmId is required when ShippingCustomerAddressCrmId is provided { ShippingCustomerCrmId: "00000000-0000-0000-0000-000000000000" }
CANNOT_PROVIDE_BOTH_SHIPPING_ENTITY_AND_ADDRESS Cannot provide both ShippingEntityId and ShippingCustomerAddressCrmId { ShippingEntityId: 12345, ShippingCustomerAddressCrmId: "B47C3C38-8B14-4CEE-9EFC-EA32981AC1C8" }
MUST_PROVIDE_AT_LEAST_ONE_ITEM Pending Dropship Order requires at least one item None
ITEM_MUST_PROVIDE_CATALOG_ID Item CatalogId is required { CatalogId: "00000000-0000-0000-0000-000000000000", Sku: "12345" }
ITEM_MUST_PROVIDE_QUANTITY Item Quantity must be greater than 0 { CatalogId: "B47C3C38-8B14-4CEE-9EFC-EA32981AC1C8", Quantity: 0 }
ITEM_MUST_PROVIDE_DESCRIPTION Item Description is required { CatalogId: "B47C3C38-8B14-4CEE-9EFC-EA32981AC1C8", Description: "" }

REQUESTS

POST a Pending Dropship Order

Request

POST /Companies({CompanyId})/PendingOrderCreation

Example Request

POST /Companies(14146)/PendingOrderCreation
Authorization: Bearer (Access Token)
Accept: application/json
Content-Type: application/json

{
    "SupplierId": 81553,
    "RetailerId": 14146,
    "LocationId": 15726,
    "ShippingCustomerCrmId": "c080322b-9330-866d-feb4-a7aa6bb014e4",
    "ShippingCustomerAddressCrmId": "e4a85988-3173-7dfa-85e5-032e29233228",
    "BillingCustomerCrmId": "c5b65166-4627-95a7-c88d-c428e274d776",
    "BillingCustomerAddressCrmId": "c6a84bfb-78a6-3d17-4086-c794eec8088b",
    "ServiceOriginName": "Order",
    "ServiceOriginOrderId": "26eeb937-a574-5b5e-5bb3-2d78a1563b38",
    "ClientOriginName": "POS",
    "PrintableId": "7B1Q84D",
    "ShippingMethod": 1,
    "ShippingMethodName": "USPS",
    "ShippingCost": 19.99,
    "ShippingEntityId": 25452,
    "Items": [
        {
            "CatalogId": "719dfd4f-5123-6543-b259-22ab4f4e19b7",
            "Sku": "MAG484-BLK",
            "Quantity": 1,
            "SellingPrice": 11.95,
            "Description": "Apple Iphone 6 case - Black",
            "Cost": 19.99
        }
    ]
}
curl -X POST "https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrderCreation" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
    "SupplierId": 81553,
    "RetailerId": 14146,
    "LocationId": 15726,
    "ShippingCustomerCrmId": "c080322b-9330-866d-feb4-a7aa6bb014e4",
    "ShippingCustomerAddressCrmId": "e4a85988-3173-7dfa-85e5-032e29233228",
    "BillingCustomerCrmId": "c5b65166-4627-95a7-c88d-c428e274d776",
    "BillingCustomerAddressCrmId": "c6a84bfb-78a6-3d17-4086-c794eec8088b",
    "ServiceOriginName": "Order",
    "ServiceOriginOrderId": "26eeb937-a574-5b5e-5bb3-2d78a1563b38",
    "ClientOriginName": "POS",
    "PrintableId": "7B1Q84D",
    "ShippingMethod": 1,
    "ShippingMethodName": "USPS",
    "ShippingCost": 19.99,
    "ShippingEntityId": 25452,
    "Items": [
        {
            "CatalogId": "719dfd4f-5123-6543-b259-22ab4f4e19b7",
            "Sku": "MAG484-BLK",
            "Quantity": 1,
            "SellingPrice": 11.95,
            "Description": "Apple Iphone 6 case - Black",
            "Cost": 19.99
        }
    ]
}'
static IRestResponse CreatingAPendingDropshipOrder()
{
    var client = new RestClient("https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrderCreation");
    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", "{\"SupplierId\":81553,\"RetailerId\":14146,\"LocationId\":15726,\"ShippingCustomerCrmId\":\"c080322b-9330-866d-feb4-a7aa6bb014e4\",\"ShippingCustomerAddressCrmId\":\"e4a85988-3173-7dfa-85e5-032e29233228\",\"BillingCustomerCrmId\":\"c5b65166-4627-95a7-c88d-c428e274d776\",\"BillingCustomerAddressCrmId\":\"c6a84bfb-78a6-3d17-4086-c794eec8088b\",\"ServiceOriginName\":\"Order\",\"ServiceOriginOrderId\":\"26eeb937-a574-5b5e-5bb3-2d78a1563b38\",\"ClientOriginName\":\"POS\",\"PrintableId\":\"7B1Q84D\",\"ShippingMethod\":1,\"ShippingMethodName\":\"USPS\",\"ShippingCost\":19.99,\"ShippingEntityId\":25452,\"Items\":[{\"CatalogId\":\"719dfd4f-5123-6543-b259-22ab4f4e19b7\",\"Sku\":\"MAG484-BLK\",\"Quantity\":1,\"SellingPrice\":11.95,\"Description\":\"Apple Iphone 6 case - Black\",\"Cost\":19.99}]}", 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 CreatingAPendingDropshipOrder() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrderCreation");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"SupplierId\":81553,\"RetailerId\":14146,\"LocationId\":15726,\"ShippingCustomerCrmId\":\"c080322b-9330-866d-feb4-a7aa6bb014e4\",\"ShippingCustomerAddressCrmId\":\"e4a85988-3173-7dfa-85e5-032e29233228\",\"BillingCustomerCrmId\":\"c5b65166-4627-95a7-c88d-c428e274d776\",\"BillingCustomerAddressCrmId\":\"c6a84bfb-78a6-3d17-4086-c794eec8088b\",\"ServiceOriginName\":\"Order\",\"ServiceOriginOrderId\":\"26eeb937-a574-5b5e-5bb3-2d78a1563b38\",\"ClientOriginName\":\"POS\",\"PrintableId\":\"7B1Q84D\",\"ShippingMethod\":1,\"ShippingMethodName\":\"USPS\",\"ShippingCost\":19.99,\"ShippingEntityId\":25452,\"Items\":[{\"CatalogId\":\"719dfd4f-5123-6543-b259-22ab4f4e19b7\",\"Sku\":\"MAG484-BLK\",\"Quantity\":1,\"SellingPrice\":11.95,\"Description\":\"Apple Iphone 6 case - Black\",\"Cost\":19.99}]}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"SupplierId\":81553,\"RetailerId\":14146,\"LocationId\":15726,\"ShippingCustomerCrmId\":\"c080322b-9330-866d-feb4-a7aa6bb014e4\",\"ShippingCustomerAddressCrmId\":\"e4a85988-3173-7dfa-85e5-032e29233228\",\"BillingCustomerCrmId\":\"c5b65166-4627-95a7-c88d-c428e274d776\",\"BillingCustomerAddressCrmId\":\"c6a84bfb-78a6-3d17-4086-c794eec8088b\",\"ServiceOriginName\":\"Order\",\"ServiceOriginOrderId\":\"26eeb937-a574-5b5e-5bb3-2d78a1563b38\",\"ClientOriginName\":\"POS\",\"PrintableId\":\"7B1Q84D\",\"ShippingMethod\":1,\"ShippingMethodName\":\"USPS\",\"ShippingCost\":19.99,\"ShippingEntityId\":25452,\"Items\":[{\"CatalogId\":\"719dfd4f-5123-6543-b259-22ab4f4e19b7\",\"Sku\":\"MAG484-BLK\",\"Quantity\":1,\"SellingPrice\":11.95,\"Description\":\"Apple Iphone 6 case - Black\",\"Cost\":19.99}]}";

response = RestClient.post 'https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrderCreation', body, {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
     :'Content-Type' => 'application/json',
    } 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 201 Content-Type: application/json
{
    "Id": "a137c49d-744a-6f4b-7944-0ca377cdcbe6",
    "SupplierId": 81553,
    "RetailerId": 14146,
    "LocationId": 15726,
    "ShippingCustomerCrmId": "c080322b-9330-866d-feb4-a7aa6bb014e4",
    "ShippingCustomerAddressCrmId": "e4a85988-3173-7dfa-85e5-032e29233228",
    "BillingCustomerCrmId": "c5b65166-4627-95a7-c88d-c428e274d776",
    "BillingCustomerAddressCrmId": "c6a84bfb-78a6-3d17-4086-c794eec8088b",
    "ServiceOriginName": "Order",
    "ServiceOriginOrderId": "26eeb937-a574-5b5e-5bb3-2d78a1563b38",
    "ClientOriginName": "POS",
    "PrintableId": "7B1Q84D",
    "ShippingMethod": 1,
    "ShippingMethodName": "USPS",
    "ShippingCost": 19.99,
    "ShippingEntityId": 25452,
    "Items": [
        {
            "CatalogId": "719dfd4f-5123-6543-b259-22ab4f4e19b7",
            "Sku": "MAG484-BLK",
            "Quantity": 1,
            "SellingPrice": 11.95,
            "Description": "Apple Iphone 6 case - Black",
            "Cost": 19.99
        }
    ],
    "Status": "Validated",
    "CreatedDate": "2017-04-10T19:03:20.35",
    "FailedValidationReasons": [
        {
            "ReasonCode": "SUPPLIER_NOT_FOUND",
            "Fields": [
                {
                    "{FieldName}": "RetailerId",
                    "FailureResponse": "Entity Not Found"
                }
            ]
        }
    ],
    "IqReferenceId": "CROWFIN42409"
}

PendingOrder

GET Pending Dropship Orders

Combine search filters using the word and, for example: ?$filter=Status eq 'Validated' and SupplierId eq 1456

All search criteria except CreatedDate use the evaluator word eq.

Word Example Meaning
gte CreatedDate gte 2017-09-01 Created on or after 2017-09-01
ge CreatedDate ge 2017-09-01 Created after 2017-09-01
lte CreatedDate lte 2017-09-01 Created on or before 2017-09-01
le CreatedDate le 2017-09-01 Created before 2017-09-01

Request

GET /Companies({CompanyId})/PendingOrders?$skip={Skip}&$top={Top}&$filter={Filter}&$orderby={Order}

Example Request

GET /Companies(14146)/PendingOrders?$skip=1&$top=10&$filter=Status eq 'Validated'&$orderby=CreatedDate desc
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrders?$skip=1&$top=10&$filter=Status eq 'Validated'&$orderby=CreatedDate desc" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingPendingDropshipOrders()
{
    var client = new RestClient("https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrders?$skip=1&$top=10&$filter=Status eq 'Validated'&$orderby=CreatedDate 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 GettingPendingDropshipOrders() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrders?$skip=1&$top=10&$filter=Status eq 'Validated'&$orderby=CreatedDate desc");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrders?$skip=1&$top=10&$filter=Status eq 'Validated'&$orderby=CreatedDate desc', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "a137c49d-744a-6f4b-7944-0ca377cdcbe6",
    "SupplierId": 81553,
    "RetailerId": 14146,
    "LocationId": 15726,
    "ShippingCustomerCrmId": "c080322b-9330-866d-feb4-a7aa6bb014e4",
    "ShippingCustomerAddressCrmId": "e4a85988-3173-7dfa-85e5-032e29233228",
    "BillingCustomerCrmId": "c5b65166-4627-95a7-c88d-c428e274d776",
    "BillingCustomerAddressCrmId": "c6a84bfb-78a6-3d17-4086-c794eec8088b",
    "ServiceOriginName": "Order",
    "ServiceOriginOrderId": "26eeb937-a574-5b5e-5bb3-2d78a1563b38",
    "ClientOriginName": "POS",
    "PrintableId": "7B1Q84D",
    "ShippingMethod": 1,
    "ShippingMethodName": "USPS",
    "ShippingCost": 19.99,
    "ShippingEntityId": 25452,
    "Items": [
        {
            "CatalogId": "719dfd4f-5123-6543-b259-22ab4f4e19b7",
            "Sku": "MAG484-BLK",
            "Quantity": 1,
            "SellingPrice": 11.95,
            "Description": "Apple Iphone 6 case - Black",
            "Cost": 19.99
        }
    ],
    "Status": "Validated",
    "CreatedDate": "2017-04-10T19:03:20.35",
    "FailedValidationReasons": [
        {
            "ReasonCode": "SUPPLIER_NOT_FOUND",
            "Fields": [
                {
                    "{FieldName}": "RetailerId",
                    "FailureResponse": "Entity Not Found"
                }
            ]
        }
    ],
    "IqReferenceId": "CROWFIN42409"
}

PendingOrder

GET a Pending Dropship Order

Request

GET /Companies({CompanyId})/PendingOrders({PendingOrderId})

Example Request

GET /Companies(14146)/PendingOrders(a137c49d-744a-6f4b-7944-0ca377cdcbe6)
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrders(a137c49d-744a-6f4b-7944-0ca377cdcbe6)" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingAPendingDropshipOrder()
{
    var client = new RestClient("https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrders(a137c49d-744a-6f4b-7944-0ca377cdcbe6)");
    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 GettingAPendingDropshipOrder() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrders(a137c49d-744a-6f4b-7944-0ca377cdcbe6)");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrders(a137c49d-744a-6f4b-7944-0ca377cdcbe6)', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "a137c49d-744a-6f4b-7944-0ca377cdcbe6",
    "SupplierId": 81553,
    "RetailerId": 14146,
    "LocationId": 15726,
    "ShippingCustomerCrmId": "c080322b-9330-866d-feb4-a7aa6bb014e4",
    "ShippingCustomerAddressCrmId": "e4a85988-3173-7dfa-85e5-032e29233228",
    "BillingCustomerCrmId": "c5b65166-4627-95a7-c88d-c428e274d776",
    "BillingCustomerAddressCrmId": "c6a84bfb-78a6-3d17-4086-c794eec8088b",
    "ServiceOriginName": "Order",
    "ServiceOriginOrderId": "26eeb937-a574-5b5e-5bb3-2d78a1563b38",
    "ClientOriginName": "POS",
    "PrintableId": "7B1Q84D",
    "ShippingMethod": 1,
    "ShippingMethodName": "USPS",
    "ShippingCost": 19.99,
    "ShippingEntityId": 25452,
    "Items": [
        {
            "CatalogId": "719dfd4f-5123-6543-b259-22ab4f4e19b7",
            "Sku": "MAG484-BLK",
            "Quantity": 1,
            "SellingPrice": 11.95,
            "Description": "Apple Iphone 6 case - Black",
            "Cost": 19.99
        }
    ],
    "Status": "Validated",
    "CreatedDate": "2017-04-10T19:03:20.35",
    "FailedValidationReasons": [
        {
            "ReasonCode": "SUPPLIER_NOT_FOUND",
            "Fields": [
                {
                    "{FieldName}": "RetailerId",
                    "FailureResponse": "Entity Not Found"
                }
            ]
        }
    ],
    "IqReferenceId": "CROWFIN42409"
}

PendingOrder

Complete Pending Dropship Orders

This request sets the IqReferenceId (otherwise known as TenderId or PoReference) and completes the Pending Dropship Order(s).

Request

POST /Companies({CompanyId})/PendingOrdersCompletion

Example Request

POST /Companies(14146)/PendingOrdersCompletion
Authorization: Bearer (Access Token)
Accept: application/json
Content-Type: application/json

{
  "PendingDropshipOrderIds": [
    "a137c49d-744a-6f4b-7944-0ca377cdcbe6"
  ],
  "IqReferenceId": "CROWFIN42409"
}          

curl -X POST "https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrdersCompletion" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
  "PendingDropshipOrderIds": [
    "a137c49d-744a-6f4b-7944-0ca377cdcbe6"
  ],
  "IqReferenceId": "CROWFIN42409"
}          
'
static IRestResponse CompletePendingDropshipOrders()
{
    var client = new RestClient("https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrdersCompletion");
    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", "{\"PendingDropshipOrderIds\":[\"a137c49d-744a-6f4b-7944-0ca377cdcbe6\"],\"IqReferenceId\":\"CROWFIN42409\"}", 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 CompletePendingDropshipOrders() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrdersCompletion");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"PendingDropshipOrderIds\":[\"a137c49d-744a-6f4b-7944-0ca377cdcbe6\"],\"IqReferenceId\":\"CROWFIN42409\"}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"PendingDropshipOrderIds\":[\"a137c49d-744a-6f4b-7944-0ca377cdcbe6\"],\"IqReferenceId\":\"CROWFIN42409\"}

response = RestClient.post 'https://dropshiprc.iqmetrix.net/v1/Companies(14146)/PendingOrdersCompletion', 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": "00000000-0000-0000-0000-000000000000",
  "PendingDropshipOrderIds": [
    "a137c49d-744a-6f4b-7944-0ca377cdcbe6"
  ],
  "IqReferenceId": "CROWFIN42409"
}

ERRORS

Error Code Description Reason
HTTP 400 Bad Request Ensure first name and last name do not exceed 50 characters and email is valid
HTTP 401 Token is invalid Ensure Access Token is valid and has not expired
HTTP 403 Unauthorized Ensure Access Token is valid and user has appropriate security
HTTP 404 Not Found Ensure URI is valid
Was this page helpful?