API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

This is a DRAFT specification provided for apprasial use only, this API is not finalized and is subject to change without notice

The Electronic Product Catalog API allows you to import products into Product Library, your Catalog, and RQ.

Required Identifier

As part of EPC onboarding, a required unique identifier (VendorSku, Barcodes or ManufacturerSku) will be set in the company configuration.

The identifier is required on all Import requests and will allow EPC to determine if a given product needs to be created or updated in RQ.

ENDPOINTS

Sandbox: https://platformepcdemo.iqmetrix.net/v1
Production: https://platformepc.iqmetrix.net/v1

RESOURCES

RegularProduct

For more information about Regular Products, see Regular Products.

{
    "Id": 12,
    "Barcodes": [
        "BARCODE123"
    ],
    "ProductName": "iPhone 4S 16GB White",
    "CategoryName": "Products > Phones > Smartphones",
    "DaysKeptInStock": 10,
    "DefaultPricingAndPurchasing": {
        "AllowReturns": true,
        "Discountable": true,
        "FloorPrice": 0,
        "ForSale": true,
        "InvoiceComments": "Invoice comment",
        "LockMinMaxed": true,
        "Margin": 1,
        "MaximumQuantity": 10,
        "MinimumQuantity": 1,
        "MsrpAmount": 499.99,
        "MsrpCurrencyCode": "USD",
        "Price": 499.99,
        "PrimaryVendorName": "Apple",
        "RefundPeriod": 10,
        "RefundToUsed": false,
        "ShowOnInvoice": true,
        "StoreInStorePrice": 399.99
    },
    "Enabled": true,
    "EnforcedTrackingNumberLength": 50,
    "ExtendedAttributes": [
        {
            "Name": "ProductId",
            "Value": "66"
        }
    ],
    "GlCostOfSalesAccountNumber": "1001",
    "GlInventoryAccountNumber": "1002",
    "GlInventoryCorrectionsAccountNumber": "1001",
    "GlSalesAccountNumber": "1003",
    "IgnoreAutomaticTaxAddition": false,
    "LocationVendors": [
        {
            "Cost": 0,
            "DiscontinuedDate": "2016-01-01T12:00:00.000",
            "DoNotOrder": false,
            "EndOfLife": "2016-01-01T12:00:00.000",
            "SpecialOrder": false,
            "TargetLocationName": "Saskatchewan",
            "TargetLocationType": "RegionName",
            "VendorName": "SampleVendor",
            "WriteOff": false
        }
    ],
    "LongDescription": "The iPhone 4S is a gradualstep over the iPhone 4.",
    "ManufacturerName": "Apple",
    "ManufacturerSku": "ABC123",
    "Model": "iPhone 6",
    "PricingAndPurchasingLocations": [
        {
            "AllowReturns": true,
            "Discountable": true,
            "FloorPrice": 0,
            "ForSale": true,
            "InvoiceComments": "Invoice comment",
            "LockMinMaxed": true,
            "Margin": 1,
            "MaximumQuantity": 10,
            "MinimumQuantity": 1,
            "MsrpAmount": 499.99,
            "MsrpCurrencyCode": "USD",
            "Price": 499.99,
            "PrimaryVendorName": "Apple",
            "RefundPeriod": 10,
            "RefundToUsed": false,
            "SaleBeginDate": "2015-10-14T12:00:00.000",
            "SaleEndDate": "2015-10-18T12:00:00.000",
            "SalePrice": 399.99,
            "ShowOnInvoice": true,
            "StoreInStorePrice": 399.99,
            "TargetLocationName": "Saskatchewan",
            "TargetLocationType": "RegionName"
        }
    ],
    "PricingMethod": "Fixed",
    "ProductLabel": "iPhone 4S 16GB White",
    "ProductTypeId": 0,
    "ReleaseDate": "2011-10-14T12:00:00.000",
    "Serialized": true,
    "SerialNumberPromptText": "Serial prompt text here",
    "ShortDescription": "Better than the iPhone 3G",
    "SourceRowNumber": 15,
    "Vendors": [
        {
            "Cost": 0,
            "DiscontinuedDate": "2016-01-01T12:00:00.000",
            "DoNotOrder": false,
            "EndOfLife": "2016-01-01T12:00:00.000",
            "SpecialOrder": false,
            "VendorName": "SampleVendor",
            "VendorSku": "DEF987",
            "WriteOff": false
        }
    ],
    "WarehouseLocation": "Cornwall"
}
Name Description  
Id (Integer) Identifier  
Barcodes (Array[string](20)) Barcodes for this Product  
ProductName (String(100)) Name  
CategoryName (String) Either category name or path to the Category, delimited by >  
DaysKeptInStock (Integer) Number of days the Product can remain in stock  
DefaultPricingAndPurchasing (RegularProductPricing) Default pricing  
Enabled (Boolean) A flag to indicate if this Product is Enabled. Defaults to true  
EnforcedTrackingNumberLength (Integer) A value that restricts tracking number length  
ExtendedAttributes (Array[object]) Additional attributes to store with the Product  
ExtendedAttributes.Name (String) Name  
ExtendedAttributes.Value (String) Value  
GlCostOfSalesAccountNumber (String) Account number for Cost of Sales, see G/L Account Setup for more information  
GlInventoryAccountNumber (String) Account number for Inventory, see G/L Account Setup for more information  
GlInventoryCorrectionsAccountNumber (String) Account number for Inventory Corrections, see G/L Account Setup for more information  
GlSalesAccountNumber (String) Account number for Sales, see G/L Account Setup for more information  
IgnoreAutomaticTaxAddition (Boolean) Ensures that taxes will not be added as part of the automatic tax process. Defaults to false  
LocationVendors (Array[LocationVendor]) Vendors for each location  
LongDescription (String) Long description  
ManufacturerName (String) Name of a Manufacturer  
ManufacturerSku (String(50)) Manufacturer SKU  
Model (String) Model  
PricingAndPurchasingLocations (Array[RegularProductPricingLocation]) Pricing for locations  
PricingMethod (String)    
ProductLabel (String) Used to identify product name on label print outs  
ProductTypeId (Integer) Identifier for a ProductType  
ReleaseDate (DateTime) Release Date, in UTC  
Serialized (Boolean) A flag to indicate Product is serialized  
SerialNumberPromptText (String(200)) Text displayed when user is prompted to enter a serial number for the product  
ShortDescription (String) Short description  
SourceRowNumber (Integer) If this product was imported from a spreadsheet, the row location of the product in the spreadsheet  
Vendors (Array[Vendor]) Collection of Vendor SKUs  
WarehouseLocation (String(100)) Name of the Warehouse location  
RefundLink (String) Reserved for internal use  
ProductLink (String) Reserved for internal use  

RegularProductPricing

When a new RegularProductPricing is created, the default pricing values will be used for any properties that are not supplied. However, for any subsequent updates, each RegularProductPricing will have to be changed individually as the change(s) to default pricing fields will not propagate.
{
    "AllowReturns": true,
    "Discountable": true,
    "FloorPrice": 0,
    "ForSale": true,
    "InvoiceComments": "Invoice comment",
    "LockMinMaxed": true,
    "Margin": 1,
    "MaximumQuantity": 10,
    "MinimumQuantity": 1,
    "MsrpAmount": 499.99,
    "MsrpCurrencyCode": "USD",
    "Price": 499.99,
    "PrimaryVendorName": "Apple",
    "RefundPeriod": 10,
    "RefundToUsed": false,
    "ShowOnInvoice": true,
    "StoreInStorePrice": 399.99
}
Name Description
AllowReturns (Boolean) A flag to indicate if the Product can be returned
Discountable (Boolean) A flag to indicate if the Product can be discounted, defaults to true
FloorPrice (Object) Floor pricing allows you to keep a product as Discountable but set a minimum price that it can be sold at to ensure margins. See Floor Pricing for more details.
ForSale (Boolean) A flag to indicate if the product can be sold. Defaults to true
InvoiceComments (String(5000)) Comments that will be printed on the invoice every time the Product is sold
LockMinMaxed (Boolean) A flag to indicate if the MinimumQuantity/MaximumQuantity amounts are locked (true) which prevents them from being updated by mass updates.
Margin (Object) Margin automatically applied to this Product
MaximumQuantity (Integer) Maximum quantity that should be on hand at any time
MinimumQuantity (Integer) Minimum quantity that should be on hand at any time
MsrpAmount (Object) Manufacturer’s suggested retail price
MsrpCurrencyCode (String) Currency
Price (Object) Company-wide default unit price
PrimaryVendorName (String) Name of the primary vendor for this Product
RefundPeriod (Integer) Number of days the Product can be refunded before an override is required to refund
RefundToUsed (Boolean) A flag to indicate that this Product can be refunded and then tagged as used
ShowOnInvoice (Boolean) A flag to indicate if the price should be shown on the invoice
StoreInStorePrice (Object) Store in Store price. See Store In Store for more information

RegularProductPricingLocation

{
    "AllowReturns": true,
    "Discountable": true,
    "FloorPrice": 0,
    "ForSale": true,
    "InvoiceComments": "Invoice comment",
    "LockMinMaxed": true,
    "Margin": 1,
    "MaximumQuantity": 10,
    "MinimumQuantity": 1,
    "MsrpAmount": 499.99,
    "MsrpCurrencyCode": "USD",
    "Price": 499.99,
    "PrimaryVendorName": "Apple",
    "RefundPeriod": 10,
    "RefundToUsed": false,
    "SaleBeginDate": "2015-10-14T12:00:00.000",
    "SaleEndDate": "2015-10-18T12:00:00.000",
    "SalePrice": 399.99,
    "ShowOnInvoice": true,
    "StoreInStorePrice": 399.99,
    "TargetLocationName": "Saskatchewan",
    "TargetLocationType": "RegionName"
}
Name Description
AllowReturns (Boolean) A flag to indicate if the Product can be returned
Discountable (Boolean) A flag to indicate if the Product can be discounted, defaults to true
FloorPrice (Object) Floor pricing allows you to keep a product as Discountable but set a minimum price that it can be sold at to ensure margins. See Floor Pricing for more details.
ForSale (Boolean) A flag to indicate if the product can be sold. Defaults to true
InvoiceComments (String(5000)) Comments that will be printed on the invoice every time the Product is sold
LockMinMaxed (Boolean) A flag to indicate if the MinimumQuantity/MaximumQuantity amounts are locked (true) which prevents them from being updated by mass updates.
Margin (Object) Margin automatically applied to this Product
MaximumQuantity (Integer) Maximum quantity that should be on hand at any time
MinimumQuantity (Integer) Minimum quantity that should be on hand at any time
MsrpAmount (Object) Manufacturer’s suggested retail price
MsrpCurrencyCode (String) Currency
Price (Object) Company-wide default unit price
PrimaryVendorName (String) Name of the primary vendor for this Product
RefundPeriod (Integer) Number of days the Product can be refunded before an override is required to refund
RefundToUsed (Boolean) A flag to indicate that this Product can be refunded and then tagged as used
SaleBeginDate (DateTime) Sale begin date, in UTC
SaleEndDate (DateTime) Sale end date, in UTC
SalePrice (Object) Sale price will override FloorPrice if it is lower
ShowOnInvoice (Boolean) A flag to indicate if the price should be shown on the invoice
StoreInStorePrice (Object) Store in Store price. See Store In Store for more information
TargetLocationName (String) Name of a channel, region, district or location to apply this pricing to. To select the entire Company, leave this value empty and select All for TargetLocationType
TargetLocationType (String) Location type

NonStockedProduct

For more information about Non-Stocked Products, see Non-Stocked Products.

{
    "Id": 14,
    "ProductName": "Prepaid Rate Plan",
    "CategoryName": "Rate Plans > Rate Plans",
    "DefaultPricing": {
        "AllowReturns": true,
        "CarrierPrice": 0,
        "Cost": 0,
        "Discountable": true,
        "FloorPrice": 0,
        "ForSale": true,
        "InvoiceComments": "Invoice comment",
        "Margin": 1,
        "Price": 499.99,
        "RefundPeriod": 10,
        "ShowOnInvoice": true,
        "StoreInStorePrice": 399.99
    },
    "Enabled": true,
    "EnforcedTrackingNumberLength": 50,
    "ExtendedAttributes": [
        {
            "Name": "ProductId",
            "Value": "66"
        }
    ],
    "FloorPrice": 0,
    "GlCostOfSalesAccountNumber": "1001",
    "GlInventoryAccountNumber": "1002",
    "GlSalesAccountNumber": "1003",
    "IgnoreAutomaticTaxAddition": false,
    "LongDescription": "Prepaid plan forpeople on the go",
    "PricingLocations": [
        {
            "AllowReturns": true,
            "CarrierPrice": 0,
            "Cost": 0,
            "Discountable": true,
            "FloorPrice": 0,
            "ForSale": true,
            "InvoiceComments": "Invoice comment",
            "Margin": 1,
            "Price": 499.99,
            "SaleBeginDate": "2015-10-14T12:00:00.000",
            "SaleEndDate": "2015-10-18T12:00:00.000",
            "SalePrice": 399.99,
            "ShowOnInvoice": true,
            "RefundPeriod": 10,
            "StoreInStorePrice": 399.99,
            "TargetLocationName": "Saskatchewan",
            "TargetLocationType": "RegionName"
        }
    ],
    "PricingMethod": "Fixed",
    "ProductLabel": "Prepaid Rate Plan",
    "ProductTypeId": 2,
    "Serialized": true,
    "SerialNumberPromptText": "Serial prompt text here",
    "ShortDescription": "Prepaid plan",
    "SourceRowNumber": 15,
    "VendorSku": "DEF987"
}
Name Description  
Id (Integer) Identifier  
ProductName (String(100)) Name  
CategoryName (String) Either category name or path to the Category, delimited by >  
DefaultPricing (NonStockedProductPricing) Default pricing  
Enabled (Boolean) A flag to indicate if this Product is Enabled. Defaults to true  
EnforcedTrackingNumberLength (Integer) A value that restricts tracking number length  
ExtendedAttributes (Array[object]) Additional attributes to store with the Product  
ExtendedAttributes.Name (String) Name  
ExtendedAttributes.Value (String) Value  
FloorPrice (Object) Floor pricing allows you to keep a product as Discountable but set a minimum price that it can be sold at to ensure margins. See Floor Pricing for more details.  
GlCostOfSalesAccountNumber (String) Account number for Cost of Sales, see G/L Account Setup for more information  
GlInventoryAccountNumber (String) Account number for Inventory, see G/L Account Setup for more information  
GlSalesAccountNumber (String) Account number for Sales, see G/L Account Setup for more information  
IgnoreAutomaticTaxAddition (Boolean) Ensures that taxes will not be added as part of the automatic tax process. Defaults to false  
LongDescription (String) Long description  
PricingLocations (Array[NonStockedProductPricingLocation]) Pricing for Locations  
PricingMethod (String)    
ProductLabel (String) Used to identify product name on label print outs  
ProductTypeId (Integer) Identifier for a ProductType  
Serialized (Boolean) A flag to indicate Product is serialized  
SerialNumberPromptText (String(200)) Text displayed when user is prompted to enter a serial number for the product  
ShortDescription (String) Short description  
SourceRowNumber (Integer) If this product was imported from a spreadsheet, the row location of the product in the spreadsheet  
VendorSku (String) Vendor sku  
RefundLink (String) Reserved for internal use  
ProductLink (String) Reserved for internal use  
ClassificationTreeId (Integer) Reserved for future use  

NonStockedProductPricing

When a new NonStockedProductPricing is created, the default pricing values will be used for any properties that are not supplied. However, for any subsequent updates, each NonStockedProductPricing will have to be changed individually as the change(s) to default pricing fields will not propagate.
{
    "AllowReturns": true,
    "CarrierPrice": 0,
    "Cost": 0,
    "Discountable": true,
    "FloorPrice": 0,
    "ForSale": true,
    "InvoiceComments": "Invoice comment",
    "Margin": 1,
    "Price": 499.99,
    "RefundPeriod": 10,
    "ShowOnInvoice": true,
    "StoreInStorePrice": 399.99
}
Name Description
AllowReturns (Boolean) A flag to indicate if the Product can be returned
CarrierPrice (Object) Carrier price
Cost (Decimal) Cost of the Item from the Vendor
Discountable (Boolean) A flag to indicate if the Product can be discounted, defaults to true
FloorPrice (Object) Floor pricing allows you to keep a product as Discountable but set a minimum price that it can be sold at to ensure margins. See Floor Pricing for more details.
ForSale (Boolean) A flag to indicate if the product can be sold. Defaults to true
InvoiceComments (String(5000)) Comments that will be printed on the invoice every time the Product is sold
Margin (Object) Margin automatically applied to this Product
Price (Object) Company-wide default unit price
RefundPeriod (Integer) Number of days the Product can be refunded before an override is required to refund
ShowOnInvoice (Boolean) A flag to indicate if the price should be shown on the invoice
StoreInStorePrice (Object) Store in Store price. See Store In Store for more information

NonStockedProductPricingLocation

{
    "AllowReturns": true,
    "CarrierPrice": 0,
    "Cost": 0,
    "Discountable": true,
    "FloorPrice": 0,
    "ForSale": true,
    "InvoiceComments": "Invoice comment",
    "Margin": 1,
    "Price": 499.99,
    "SaleBeginDate": "2015-10-14T12:00:00.000",
    "SaleEndDate": "2015-10-18T12:00:00.000",
    "SalePrice": 399.99,
    "ShowOnInvoice": true,
    "RefundPeriod": 10,
    "StoreInStorePrice": 399.99,
    "TargetLocationName": "Saskatchewan",
    "TargetLocationType": "RegionName"
}
Name Description
AllowReturns (Boolean) A flag to indicate if the Product can be returned
CarrierPrice (Object) Carrier price
Cost (Decimal) Cost of the Item from the Vendor
Discountable (Boolean) A flag to indicate if the Product can be discounted, defaults to true
FloorPrice (Object) Floor pricing allows you to keep a product as Discountable but set a minimum price that it can be sold at to ensure margins. See Floor Pricing for more details.
ForSale (Boolean) A flag to indicate if the product can be sold. Defaults to true
InvoiceComments (String(5000)) Comments that will be printed on the invoice every time the Product is sold
Margin (Object) Margin automatically applied to this Product
Price (Object) Company-wide default unit price
SaleBeginDate (DateTime) Sale begin date, in UTC
SaleEndDate (DateTime) Sale end date, in UTC
SalePrice (Object) Sale price will override FloorPrice if it is lower
ShowOnInvoice (Boolean) A flag to indicate if the price should be shown on the invoice
RefundPeriod (Integer) Number of days the Product can be refunded before an override is required to refund
StoreInStorePrice (Object) Store in Store price. See Store In Store for more information
TargetLocationName (String) Name of a channel, region, district or location to apply this pricing to. To select the entire Company, leave this value empty and select All for TargetLocationType
TargetLocationType (String) Location type

VendorRebateProduct

For more information about Vendor Rebates, see Vendor Rebates.

{
    "Id": 16,
    "VendorName": "SampleVendor",
    "ProductName": "2 YR New Act",
    "CategoryName": "Rate Plans > Rate Plan Rebates",
    "DefaultPricing": {
        "AllowReturns": true,
        "CarrierPrice": 0,
        "Cost": 0,
        "Discountable": true,
        "FloorPrice": 0,
        "ForSale": true,
        "InvoiceComments": "Invoice comment",
        "Margin": 1,
        "Price": 499.99,
        "RefundPeriod": 10,
        "ShowOnInvoice": true,
        "StoreInStorePrice": 399.99
    },
    "Enabled": true,
    "EnforcedTrackingNumberLength": 50,
    "ExtendedAttributes": [
        {
            "Name": "ProductId",
            "Value": "66"
        }
    ],
    "GlCostOfSalesAccountNumber": "1001",
    "GlInventoryAccountNumber": "1002",
    "GlSalesAccountNumber": "1003",
    "IgnoreAutomaticTaxAddition": false,
    "LongDescription": "Rebate on 2 year actiations",
    "PricingLocations": [
        {
            "AllowReturns": true,
            "CarrierPrice": 0,
            "Cost": 0,
            "Discountable": true,
            "FloorPrice": 0,
            "ForSale": true,
            "InvoiceComments": "Invoice comment",
            "Margin": 1,
            "Price": 499.99,
            "SaleBeginDate": "2015-10-14T12:00:00.000",
            "SaleEndDate": "2015-10-18T12:00:00.000",
            "SalePrice": 399.99,
            "ShowOnInvoice": true,
            "RefundPeriod": 10,
            "StoreInStorePrice": 399.99,
            "TargetLocationName": "Saskatchewan",
            "TargetLocationType": "RegionName"
        }
    ],
    "PricingMethod": "Fixed",
    "ProductLabel": "2 YR New Act",
    "ProductTypeId": 1,
    "Serialized": true,
    "SerialNumberPromptText": "Serial prompt text here",
    "ShortDescription": "2 yr rebate",
    "SourceRowNumber": 15,
    "VendorAccountName": "Verizon",
    "VendorSku": "DEF987"
}
Name Description  
Id (Integer) Identifier  
VendorName (String) Vendor name  
ProductName (String(100)) Name  
CategoryName (String) Either category name or path to the Category, delimited by >  
DefaultPricing (NonStockedProductPricing) Default pricing information  
Enabled (Boolean) A flag to indicate if this Product is Enabled. Defaults to true  
EnforcedTrackingNumberLength (Integer) A value that restricts tracking number length  
ExtendedAttributes (Array[object]) Additional attributes to store with the Product  
ExtendedAttributes.Name (String) Name  
ExtendedAttributes.Value (String) Value  
GlCostOfSalesAccountNumber (String) Account number for Cost of Sales, see G/L Account Setup for more information  
GlInventoryAccountNumber (String) Account number for Inventory, see G/L Account Setup for more information  
GlSalesAccountNumber (String) Account number for Sales, see G/L Account Setup for more information  
IgnoreAutomaticTaxAddition (Boolean) Ensures that taxes will not be added as part of the automatic tax process. Defaults to false  
LongDescription (String) Long description  
PricingLocations (Array[NonStockedProductPricingLocation]) Pricing for Locations  
PricingMethod (String)    
ProductLabel (String) Used to identify product name on label print outs  
ProductTypeId (Integer) Identifier for a ProductType  
Serialized (Boolean) A flag to indicate Product is serialized  
SerialNumberPromptText (String(200)) Text displayed when user is prompted to enter a serial number for the product  
ShortDescription (String) Short description  
SourceRowNumber (Integer) If this product was imported from a spreadsheet, the row location of the product in the spreadsheet  
VendorAccountName (String) Vendor account name  
VendorSku (String) Vendor sku  
RefundLink (String) Reserved for internal use  
ProductLink (String) Reserved for internal use  
ClassificationTreeId (Integer) Reserved for future use  

NonRevenueProduct

The NonStockedProduct and NonRevenueProduct resources are identical, but will diverge in the future as different properties are added the resources

For more information about Non-Revenue Products, see Non-Revenue Products

{
    "Id": 18,
    "ProductName": "Recycling Fee",
    "CategoryName": "Misc > Misc. Fees",
    "DefaultPricing": {
        "AllowReturns": true,
        "CarrierPrice": 0,
        "Cost": 0,
        "Discountable": true,
        "FloorPrice": 0,
        "ForSale": true,
        "InvoiceComments": "Invoice comment",
        "Margin": 1,
        "Price": 499.99,
        "RefundPeriod": 10,
        "ShowOnInvoice": true,
        "StoreInStorePrice": 399.99
    },
    "Enabled": true,
    "EnforcedTrackingNumberLength": 50,
    "ExtendedAttributes": [
        {
            "Name": "ProductId",
            "Value": "66"
        }
    ],
    "FloorPrice": 0,
    "GlCostOfSalesAccountNumber": "1001",
    "GlInventoryAccountNumber": "1002",
    "GlSalesAccountNumber": "1003",
    "IgnoreAutomaticTaxAddition": false,
    "LongDescription": "Recycling fee to disposeof old handset",
    "PricingLocations": [
        {
            "AllowReturns": true,
            "CarrierPrice": 0,
            "Cost": 0,
            "Discountable": true,
            "FloorPrice": 0,
            "ForSale": true,
            "InvoiceComments": "Invoice comment",
            "Margin": 1,
            "Price": 499.99,
            "SaleBeginDate": "2015-10-14T12:00:00.000",
            "SaleEndDate": "2015-10-18T12:00:00.000",
            "SalePrice": 399.99,
            "ShowOnInvoice": true,
            "RefundPeriod": 10,
            "StoreInStorePrice": 399.99,
            "TargetLocationName": "Saskatchewan",
            "TargetLocationType": "RegionName"
        }
    ],
    "PricingMethod": "Fixed",
    "ProductLabel": "Recycling Fee",
    "ProductTypeId": 4,
    "Serialized": true,
    "SerialNumberPromptText": "Serial prompt text here",
    "ShortDescription": "Recycling fee",
    "SourceRowNumber": 15,
    "VendorSku": "DEF987"
}
Name Description  
Id (Integer) Identifier  
ProductName (String(100)) Name  
CategoryName (String) Either category name or path to the Category, delimited by >  
DefaultPricing (NonStockedProductPricing) Default pricing information  
Enabled (Boolean) A flag to indicate if this Product is Enabled. Defaults to true  
EnforcedTrackingNumberLength (Integer) A value that restricts tracking number length  
ExtendedAttributes (Array[object]) Additional attributes to store with the Product  
ExtendedAttributes.Name (String) Name  
ExtendedAttributes.Value (String) Value  
FloorPrice (Object) Floor pricing allows you to keep a product as Discountable but set a minimum price that it can be sold at to ensure margins. See Floor Pricing for more details.  
GlCostOfSalesAccountNumber (String) Account number for Cost of Sales, see G/L Account Setup for more information  
GlInventoryAccountNumber (String) Account number for Inventory, see G/L Account Setup for more information  
GlSalesAccountNumber (String) Account number for Sales, see G/L Account Setup for more information  
IgnoreAutomaticTaxAddition (Boolean) Ensures that taxes will not be added as part of the automatic tax process. Defaults to false  
LongDescription (String) Long description  
PricingLocations (Array[NonStockedProductPricingLocation]) Pricing for Locations  
PricingMethod (String)    
ProductLabel (String) Used to identify product name on label print outs  
ProductTypeId (Integer) Identifier for a ProductType  
Serialized (Boolean) A flag to indicate Product is serialized  
SerialNumberPromptText (String(200)) Text displayed when user is prompted to enter a serial number for the product  
ShortDescription (String) Short description  
SourceRowNumber (Integer) If this product was imported from a spreadsheet, the row location of the product in the spreadsheet  
VendorSku (String) Vendor sku  
RefundLink (String) Reserved for internal use  
ProductLink (String) Reserved for internal use  
ClassificationTreeId (Integer) Reserved for future use  

LocationVendor

{
    "Cost": 0,
    "DiscontinuedDate": "2016-01-01T12:00:00.000",
    "DoNotOrder": false,
    "EndOfLife": "2016-01-01T12:00:00.000",
    "SpecialOrder": false,
    "TargetLocationName": "Saskatchewan",
    "TargetLocationType": "RegionName",
    "VendorName": "SampleVendor",
    "WriteOff": false
}
Name Description
Cost (Decimal) Cost of the Item from the Vendor
DiscontinuedDate (DateTime) Date the Product will no longer be sold, in UTC
DoNotOrder (Boolean) A flag to indicate the Product can not be ordered from this Location
EndOfLife (DateTime) Date for Product end of life
SpecialOrder (Boolean) A flag to indicate that the Product is a special order
TargetLocationName (String) Name of a channel, region, district or location to apply this pricing to. To select the entire Company, leave this value empty and select All for TargetLocationType
TargetLocationType (String) Location type
VendorName (String) Vendor name
WriteOff (Boolean) A flag to indicate that the Product is a write-off

Vendor

{
    "Cost": 0,
    "DiscontinuedDate": "2016-01-01T12:00:00.000",
    "DoNotOrder": false,
    "EndOfLife": "2016-01-01T12:00:00.000",
    "SpecialOrder": false,
    "VendorName": "SampleVendor",
    "VendorSku": "DEF987",
    "WriteOff": false
}
Name Description
Cost (Decimal) Cost of the Item from the Vendor
DiscontinuedDate (DateTime) Date the Product will no longer be sold, in UTC
DoNotOrder (Boolean) A flag to indicate the Product can not be ordered from this Location
EndOfLife (DateTime) Date for Product end of life
SpecialOrder (Boolean) A flag to indicate that the Product is a special order
VendorName (String) Vendor name
VendorSku (String) Vendor sku
WriteOff (Boolean) A flag to indicate that the Product is a write-off

BatchStatus

{
    "BatchId": 3,
    "CompanyId": 14146,
    "DateCreated": "2015-09-14T22:11:16.5670000Z",
    "FailedCount": 1,
    "PendingCount": 1,
    "Products": [
        {
            "ProductName": "Galaxy Note 6",
            "SourceRowNumber": 15,
            "StatusCode": 2,
            "StatusName": "Error",
            "ErrorMessage": "No matching RQ manufacturer found with the name appple"
        }
    ],
    "SourceFileName": "Products.xslx",
    "StatusCode": 3,
    "StatusName": "Completed",
    "SuccessfulCount": 1,
    "TotalProductCount": 2
}
Name Description
BatchId (Integer) Identifier of the Batch
CompanyId (Integer) Identifier for a Company
DateCreated (DateTime) Date this Batch was created
FailedCount (Integer) Number of products that failled to process
PendingCount (Integer) Number of products pending processing
Products (Array[ProductStatus]) Product statuses
SourceFileName (String) Name of a spreadsheet, if this batch was created from an import
StatusCode (Integer) Status of the Batch, see BatchStatusCode for a list of possible values
StatusName (String) Name of the associated BatchStatus
SuccessfulCount (Integer) Number of products successfully processed
TotalProductCount (Integer) Total number of Products in the Batch

ProductStatus

{
    "ProductName": "Galaxy Note 6",
    "SourceRowNumber": 15,
    "StatusCode": 2,
    "StatusName": "Error",
    "ErrorMessage": "No matching RQ manufacturer found with the name appple"
}
Name Description
ProductName (String(100)) Name
SourceRowNumber (Integer) If this product was imported from a spreadsheet, the row location of the product in the spreadsheet
StatusCode (Integer) Status of the import, see StatusCode for a list of possible values
StatusName (String) Name of the associated StatusCode
ErrorMessage (String) Error message

ENUMERATIONS

PricingMethod

For more information about pricing methods, see Regular Products.

Name
Fixed
Margin

BatchStatusCode

Id Name Description
0 Pending The batch has not yet been imported
1 Ready The batch has not yet been imported
2 InProgress The import is in progress
3 Completed The batch has been processed. Some products may have failed or all may have succeeded
4 Cancelled The batch was cancelled

ProductStatusCode

Id Name Description
0 Pending The Product has not yet been processed
1 Processed The Product was imported successfully
2 Error The Product encountered an error during import

ProductType

Id Name
0 RegularProduct
1 VendorRebateProduct
2 NonStockedProduct
4 NonRevenueProduct

TargetLocations

Name Locations affected
All All locations in Company
ChannelName Locations in channel specified by channel name
DistrictName Locations in district specified by district name
RegionName Locations in region specified by region name
StoreName Location specified by store name

REQUESTS

Bulk Importing Products to RQ

At least one of the following properties must be provided: RegularProducts, VendorRebateProducts, NonStockedProducts or NonRevenueProducts.

Request

POST /companies({CompanyId})/products

Example Request

POST /companies(1)/products
Authorization: Bearer (Access Token)
Accept: application/json
Content-Type: application/json

{
    "RegularProducts": [
        {
            "Barcodes": [
                "BARCODE123"
            ],
            "ProductName": "iPhone 4S 16GB White",
            "CategoryName": "Products > Phones > Smartphones",
            "DaysKeptInStock": 10,
            "DefaultPricingAndPurchasing": {
                "AllowReturns": true,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "LockMinMaxed": true,
                "Margin": 1,
                "MaximumQuantity": 10,
                "MinimumQuantity": 1,
                "MsrpAmount": 499.99,
                "MsrpCurrencyCode": "USD",
                "Price": 499.99,
                "PrimaryVendorName": "Apple",
                "RefundPeriod": 10,
                "RefundToUsed": false,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlInventoryCorrectionsAccountNumber": "1001",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LocationVendors": [
                {
                    "Cost": 0,
                    "DiscontinuedDate": "2016-01-01T12:00:00.000",
                    "DoNotOrder": false,
                    "EndOfLife": "2016-01-01T12:00:00.000",
                    "SpecialOrder": false,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName",
                    "VendorName": "SampleVendor",
                    "WriteOff": false
                }
            ],
            "LongDescription": "The iPhone 4S is a gradualstep over the iPhone 4.",
            "ManufacturerName": "Apple",
            "ManufacturerSku": "ABC123",
            "Model": "iPhone 6",
            "PricingAndPurchasingLocations": [
                {
                    "AllowReturns": true,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "LockMinMaxed": true,
                    "Margin": 1,
                    "MaximumQuantity": 10,
                    "MinimumQuantity": 1,
                    "MsrpAmount": 499.99,
                    "MsrpCurrencyCode": "USD",
                    "Price": 499.99,
                    "PrimaryVendorName": "Apple",
                    "RefundPeriod": 10,
                    "RefundToUsed": false,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "iPhone 4S 16GB White",
            "ReleaseDate": "2011-10-14T12:00:00.000",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Better than the iPhone 3G",
            "Vendors": [
                {
                    "Cost": 0,
                    "DiscontinuedDate": "2016-01-01T12:00:00.000",
                    "DoNotOrder": false,
                    "EndOfLife": "2016-01-01T12:00:00.000",
                    "SpecialOrder": false,
                    "VendorName": "SampleVendor",
                    "VendorSku": "DEF987",
                    "WriteOff": false
                }
            ],
            "WarehouseLocation": "Cornwall"
        }
    ],
    "NonStockedProducts": [
        {
            "ProductName": "Prepaid Rate Plan",
            "CategoryName": "Rate Plans > Rate Plans",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "FloorPrice": 0,
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Prepaid plan forpeople on the go",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "Prepaid Rate Plan",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Prepaid plan",
            "VendorSku": "DEF987"
        }
    ],
    "NonRevenueProducts": [
        {
            "ProductName": "Recycling Fee",
            "CategoryName": "Misc > Misc. Fees",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "FloorPrice": 0,
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Recycling fee to disposeof old handset",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "Recycling Fee",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Recycling fee",
            "VendorSku": "DEF987"
        }
    ],
    "VendorRebateProducts": [
        {
            "VendorName": "SampleVendor",
            "ProductName": "2 YR New Act",
            "CategoryName": "Rate Plans > Rate Plan Rebates",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Rebate on 2 year actiations",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "2 YR New Act",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "2 yr rebate",
            "VendorAccountName": "Verizon",
            "VendorSku": "DEF987"
        }
    ]
}
curl -X POST "https://platformepcdemo.iqmetrix.net/v1/companies(1)/products" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
    "RegularProducts": [
        {
            "Barcodes": [
                "BARCODE123"
            ],
            "ProductName": "iPhone 4S 16GB White",
            "CategoryName": "Products > Phones > Smartphones",
            "DaysKeptInStock": 10,
            "DefaultPricingAndPurchasing": {
                "AllowReturns": true,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "LockMinMaxed": true,
                "Margin": 1,
                "MaximumQuantity": 10,
                "MinimumQuantity": 1,
                "MsrpAmount": 499.99,
                "MsrpCurrencyCode": "USD",
                "Price": 499.99,
                "PrimaryVendorName": "Apple",
                "RefundPeriod": 10,
                "RefundToUsed": false,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlInventoryCorrectionsAccountNumber": "1001",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LocationVendors": [
                {
                    "Cost": 0,
                    "DiscontinuedDate": "2016-01-01T12:00:00.000",
                    "DoNotOrder": false,
                    "EndOfLife": "2016-01-01T12:00:00.000",
                    "SpecialOrder": false,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName",
                    "VendorName": "SampleVendor",
                    "WriteOff": false
                }
            ],
            "LongDescription": "The iPhone 4S is a gradualstep over the iPhone 4.",
            "ManufacturerName": "Apple",
            "ManufacturerSku": "ABC123",
            "Model": "iPhone 6",
            "PricingAndPurchasingLocations": [
                {
                    "AllowReturns": true,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "LockMinMaxed": true,
                    "Margin": 1,
                    "MaximumQuantity": 10,
                    "MinimumQuantity": 1,
                    "MsrpAmount": 499.99,
                    "MsrpCurrencyCode": "USD",
                    "Price": 499.99,
                    "PrimaryVendorName": "Apple",
                    "RefundPeriod": 10,
                    "RefundToUsed": false,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "iPhone 4S 16GB White",
            "ReleaseDate": "2011-10-14T12:00:00.000",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Better than the iPhone 3G",
            "Vendors": [
                {
                    "Cost": 0,
                    "DiscontinuedDate": "2016-01-01T12:00:00.000",
                    "DoNotOrder": false,
                    "EndOfLife": "2016-01-01T12:00:00.000",
                    "SpecialOrder": false,
                    "VendorName": "SampleVendor",
                    "VendorSku": "DEF987",
                    "WriteOff": false
                }
            ],
            "WarehouseLocation": "Cornwall"
        }
    ],
    "NonStockedProducts": [
        {
            "ProductName": "Prepaid Rate Plan",
            "CategoryName": "Rate Plans > Rate Plans",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "FloorPrice": 0,
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Prepaid plan forpeople on the go",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "Prepaid Rate Plan",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Prepaid plan",
            "VendorSku": "DEF987"
        }
    ],
    "NonRevenueProducts": [
        {
            "ProductName": "Recycling Fee",
            "CategoryName": "Misc > Misc. Fees",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "FloorPrice": 0,
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Recycling fee to disposeof old handset",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "Recycling Fee",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Recycling fee",
            "VendorSku": "DEF987"
        }
    ],
    "VendorRebateProducts": [
        {
            "VendorName": "SampleVendor",
            "ProductName": "2 YR New Act",
            "CategoryName": "Rate Plans > Rate Plan Rebates",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Rebate on 2 year actiations",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "2 YR New Act",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "2 yr rebate",
            "VendorAccountName": "Verizon",
            "VendorSku": "DEF987"
        }
    ]
}'
static IRestResponse BulkImportingProductsToRq()
{
    var client = new RestClient("https://platformepcdemo.iqmetrix.net/v1/companies(1)/products");
    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", "{\"RegularProducts\":[{\"Barcodes\":[\"BARCODE123\"],\"ProductName\":\"iPhone 4S 16GB White\",\"CategoryName\":\"Products > Phones > Smartphones\",\"DaysKeptInStock\":10,\"DefaultPricingAndPurchasing\":{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlInventoryCorrectionsAccountNumber\":\"1001\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LocationVendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\",\"VendorName\":\"SampleVendor\",\"WriteOff\":false}],\"LongDescription\":\"The iPhone 4S is a gradualstep over the iPhone 4.\",\"ManufacturerName\":\"Apple\",\"ManufacturerSku\":\"ABC123\",\"Model\":\"iPhone 6\",\"PricingAndPurchasingLocations\":[{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"iPhone 4S 16GB White\",\"ReleaseDate\":\"2011-10-14T12:00:00.000\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Better than the iPhone 3G\",\"Vendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"VendorName\":\"SampleVendor\",\"VendorSku\":\"DEF987\",\"WriteOff\":false}],\"WarehouseLocation\":\"Cornwall\"}],\"NonStockedProducts\":[{\"ProductName\":\"Prepaid Rate Plan\",\"CategoryName\":\"Rate Plans > Rate Plans\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Prepaid plan forpeople on the go\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Prepaid Rate Plan\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Prepaid plan\",\"VendorSku\":\"DEF987\"}],\"NonRevenueProducts\":[{\"ProductName\":\"Recycling Fee\",\"CategoryName\":\"Misc > Misc. Fees\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Recycling fee to disposeof old handset\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Recycling Fee\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Recycling fee\",\"VendorSku\":\"DEF987\"}],\"VendorRebateProducts\":[{\"VendorName\":\"SampleVendor\",\"ProductName\":\"2 YR New Act\",\"CategoryName\":\"Rate Plans > Rate Plan Rebates\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Rebate on 2 year actiations\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"2 YR New Act\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"2 yr rebate\",\"VendorAccountName\":\"Verizon\",\"VendorSku\":\"DEF987\"}]}", 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 BulkImportingProductsToRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://platformepcdemo.iqmetrix.net/v1/companies(1)/products");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"RegularProducts\":[{\"Barcodes\":[\"BARCODE123\"],\"ProductName\":\"iPhone 4S 16GB White\",\"CategoryName\":\"Products > Phones > Smartphones\",\"DaysKeptInStock\":10,\"DefaultPricingAndPurchasing\":{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlInventoryCorrectionsAccountNumber\":\"1001\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LocationVendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\",\"VendorName\":\"SampleVendor\",\"WriteOff\":false}],\"LongDescription\":\"The iPhone 4S is a gradualstep over the iPhone 4.\",\"ManufacturerName\":\"Apple\",\"ManufacturerSku\":\"ABC123\",\"Model\":\"iPhone 6\",\"PricingAndPurchasingLocations\":[{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"iPhone 4S 16GB White\",\"ReleaseDate\":\"2011-10-14T12:00:00.000\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Better than the iPhone 3G\",\"Vendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"VendorName\":\"SampleVendor\",\"VendorSku\":\"DEF987\",\"WriteOff\":false}],\"WarehouseLocation\":\"Cornwall\"}],\"NonStockedProducts\":[{\"ProductName\":\"Prepaid Rate Plan\",\"CategoryName\":\"Rate Plans > Rate Plans\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Prepaid plan forpeople on the go\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Prepaid Rate Plan\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Prepaid plan\",\"VendorSku\":\"DEF987\"}],\"NonRevenueProducts\":[{\"ProductName\":\"Recycling Fee\",\"CategoryName\":\"Misc > Misc. Fees\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Recycling fee to disposeof old handset\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Recycling Fee\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Recycling fee\",\"VendorSku\":\"DEF987\"}],\"VendorRebateProducts\":[{\"VendorName\":\"SampleVendor\",\"ProductName\":\"2 YR New Act\",\"CategoryName\":\"Rate Plans > Rate Plan Rebates\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Rebate on 2 year actiations\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"2 YR New Act\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"2 yr rebate\",\"VendorAccountName\":\"Verizon\",\"VendorSku\":\"DEF987\"}]}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"RegularProducts\":[{\"Barcodes\":[\"BARCODE123\"],\"ProductName\":\"iPhone 4S 16GB White\",\"CategoryName\":\"Products > Phones > Smartphones\",\"DaysKeptInStock\":10,\"DefaultPricingAndPurchasing\":{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlInventoryCorrectionsAccountNumber\":\"1001\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LocationVendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\",\"VendorName\":\"SampleVendor\",\"WriteOff\":false}],\"LongDescription\":\"The iPhone 4S is a gradualstep over the iPhone 4.\",\"ManufacturerName\":\"Apple\",\"ManufacturerSku\":\"ABC123\",\"Model\":\"iPhone 6\",\"PricingAndPurchasingLocations\":[{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"iPhone 4S 16GB White\",\"ReleaseDate\":\"2011-10-14T12:00:00.000\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Better than the iPhone 3G\",\"Vendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"VendorName\":\"SampleVendor\",\"VendorSku\":\"DEF987\",\"WriteOff\":false}],\"WarehouseLocation\":\"Cornwall\"}],\"NonStockedProducts\":[{\"ProductName\":\"Prepaid Rate Plan\",\"CategoryName\":\"Rate Plans > Rate Plans\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Prepaid plan forpeople on the go\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Prepaid Rate Plan\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Prepaid plan\",\"VendorSku\":\"DEF987\"}],\"NonRevenueProducts\":[{\"ProductName\":\"Recycling Fee\",\"CategoryName\":\"Misc > Misc. Fees\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Recycling fee to disposeof old handset\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Recycling Fee\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Recycling fee\",\"VendorSku\":\"DEF987\"}],\"VendorRebateProducts\":[{\"VendorName\":\"SampleVendor\",\"ProductName\":\"2 YR New Act\",\"CategoryName\":\"Rate Plans > Rate Plan Rebates\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Rebate on 2 year actiations\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"2 YR New Act\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"2 yr rebate\",\"VendorAccountName\":\"Verizon\",\"VendorSku\":\"DEF987\"}]}";

response = RestClient.post 'https://platformepcdemo.iqmetrix.net/v1/companies(1)/products', body, {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
     :'Content-Type' => 'application/json',
    } 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Status": "/v1/companies(21090)/batchStatus(123)",
    "TimestampUTC": "2016-11-15T16:43:15.1396674Z"
}

Importing Regular Products into RQ

Request

POST /companies({CompanyId})/Products

Example Request

POST /companies(1)/Products
Authorization: Bearer (Access Token)
Accept: application/json
Content-Type: application/json

{
    "RegularProducts": [
        {
            "Barcodes": [
                "BARCODE123"
            ],
            "ProductName": "iPhone 4S 16GB White",
            "CategoryName": "Products > Phones > Smartphones",
            "DaysKeptInStock": 10,
            "DefaultPricingAndPurchasing": {
                "AllowReturns": true,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "LockMinMaxed": true,
                "Margin": 1,
                "MaximumQuantity": 10,
                "MinimumQuantity": 1,
                "MsrpAmount": 499.99,
                "MsrpCurrencyCode": "USD",
                "Price": 499.99,
                "PrimaryVendorName": "Apple",
                "RefundPeriod": 10,
                "RefundToUsed": false,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlInventoryCorrectionsAccountNumber": "1001",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LocationVendors": [
                {
                    "Cost": 0,
                    "DiscontinuedDate": "2016-01-01T12:00:00.000",
                    "DoNotOrder": false,
                    "EndOfLife": "2016-01-01T12:00:00.000",
                    "SpecialOrder": false,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName",
                    "VendorName": "SampleVendor",
                    "WriteOff": false
                }
            ],
            "LongDescription": "The iPhone 4S is a gradualstep over the iPhone 4.",
            "ManufacturerName": "Apple",
            "ManufacturerSku": "ABC123",
            "Model": "iPhone 6",
            "PricingAndPurchasingLocations": [
                {
                    "AllowReturns": true,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "LockMinMaxed": true,
                    "Margin": 1,
                    "MaximumQuantity": 10,
                    "MinimumQuantity": 1,
                    "MsrpAmount": 499.99,
                    "MsrpCurrencyCode": "USD",
                    "Price": 499.99,
                    "PrimaryVendorName": "Apple",
                    "RefundPeriod": 10,
                    "RefundToUsed": false,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "iPhone 4S 16GB White",
            "ReleaseDate": "2011-10-14T12:00:00.000",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Better than the iPhone 3G",
            "Vendors": [
                {
                    "Cost": 0,
                    "DiscontinuedDate": "2016-01-01T12:00:00.000",
                    "DoNotOrder": false,
                    "EndOfLife": "2016-01-01T12:00:00.000",
                    "SpecialOrder": false,
                    "VendorName": "SampleVendor",
                    "VendorSku": "DEF987",
                    "WriteOff": false
                }
            ],
            "WarehouseLocation": "Cornwall"
        }
    ]
}
curl -X POST "https://platformepcdemo.iqmetrix.net/v1/companies(1)/Products" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
    "RegularProducts": [
        {
            "Barcodes": [
                "BARCODE123"
            ],
            "ProductName": "iPhone 4S 16GB White",
            "CategoryName": "Products > Phones > Smartphones",
            "DaysKeptInStock": 10,
            "DefaultPricingAndPurchasing": {
                "AllowReturns": true,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "LockMinMaxed": true,
                "Margin": 1,
                "MaximumQuantity": 10,
                "MinimumQuantity": 1,
                "MsrpAmount": 499.99,
                "MsrpCurrencyCode": "USD",
                "Price": 499.99,
                "PrimaryVendorName": "Apple",
                "RefundPeriod": 10,
                "RefundToUsed": false,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlInventoryCorrectionsAccountNumber": "1001",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LocationVendors": [
                {
                    "Cost": 0,
                    "DiscontinuedDate": "2016-01-01T12:00:00.000",
                    "DoNotOrder": false,
                    "EndOfLife": "2016-01-01T12:00:00.000",
                    "SpecialOrder": false,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName",
                    "VendorName": "SampleVendor",
                    "WriteOff": false
                }
            ],
            "LongDescription": "The iPhone 4S is a gradualstep over the iPhone 4.",
            "ManufacturerName": "Apple",
            "ManufacturerSku": "ABC123",
            "Model": "iPhone 6",
            "PricingAndPurchasingLocations": [
                {
                    "AllowReturns": true,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "LockMinMaxed": true,
                    "Margin": 1,
                    "MaximumQuantity": 10,
                    "MinimumQuantity": 1,
                    "MsrpAmount": 499.99,
                    "MsrpCurrencyCode": "USD",
                    "Price": 499.99,
                    "PrimaryVendorName": "Apple",
                    "RefundPeriod": 10,
                    "RefundToUsed": false,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "iPhone 4S 16GB White",
            "ReleaseDate": "2011-10-14T12:00:00.000",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Better than the iPhone 3G",
            "Vendors": [
                {
                    "Cost": 0,
                    "DiscontinuedDate": "2016-01-01T12:00:00.000",
                    "DoNotOrder": false,
                    "EndOfLife": "2016-01-01T12:00:00.000",
                    "SpecialOrder": false,
                    "VendorName": "SampleVendor",
                    "VendorSku": "DEF987",
                    "WriteOff": false
                }
            ],
            "WarehouseLocation": "Cornwall"
        }
    ]
}'
static IRestResponse ImportingRegularProductsIntoRq()
{
    var client = new RestClient("https://platformepcdemo.iqmetrix.net/v1/companies(1)/Products");
    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", "{\"RegularProducts\":[{\"Barcodes\":[\"BARCODE123\"],\"ProductName\":\"iPhone 4S 16GB White\",\"CategoryName\":\"Products > Phones > Smartphones\",\"DaysKeptInStock\":10,\"DefaultPricingAndPurchasing\":{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlInventoryCorrectionsAccountNumber\":\"1001\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LocationVendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\",\"VendorName\":\"SampleVendor\",\"WriteOff\":false}],\"LongDescription\":\"The iPhone 4S is a gradualstep over the iPhone 4.\",\"ManufacturerName\":\"Apple\",\"ManufacturerSku\":\"ABC123\",\"Model\":\"iPhone 6\",\"PricingAndPurchasingLocations\":[{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"iPhone 4S 16GB White\",\"ReleaseDate\":\"2011-10-14T12:00:00.000\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Better than the iPhone 3G\",\"Vendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"VendorName\":\"SampleVendor\",\"VendorSku\":\"DEF987\",\"WriteOff\":false}],\"WarehouseLocation\":\"Cornwall\"}]}", 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 ImportingRegularProductsIntoRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://platformepcdemo.iqmetrix.net/v1/companies(1)/Products");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"RegularProducts\":[{\"Barcodes\":[\"BARCODE123\"],\"ProductName\":\"iPhone 4S 16GB White\",\"CategoryName\":\"Products > Phones > Smartphones\",\"DaysKeptInStock\":10,\"DefaultPricingAndPurchasing\":{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlInventoryCorrectionsAccountNumber\":\"1001\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LocationVendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\",\"VendorName\":\"SampleVendor\",\"WriteOff\":false}],\"LongDescription\":\"The iPhone 4S is a gradualstep over the iPhone 4.\",\"ManufacturerName\":\"Apple\",\"ManufacturerSku\":\"ABC123\",\"Model\":\"iPhone 6\",\"PricingAndPurchasingLocations\":[{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"iPhone 4S 16GB White\",\"ReleaseDate\":\"2011-10-14T12:00:00.000\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Better than the iPhone 3G\",\"Vendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"VendorName\":\"SampleVendor\",\"VendorSku\":\"DEF987\",\"WriteOff\":false}],\"WarehouseLocation\":\"Cornwall\"}]}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"RegularProducts\":[{\"Barcodes\":[\"BARCODE123\"],\"ProductName\":\"iPhone 4S 16GB White\",\"CategoryName\":\"Products > Phones > Smartphones\",\"DaysKeptInStock\":10,\"DefaultPricingAndPurchasing\":{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlInventoryCorrectionsAccountNumber\":\"1001\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LocationVendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\",\"VendorName\":\"SampleVendor\",\"WriteOff\":false}],\"LongDescription\":\"The iPhone 4S is a gradualstep over the iPhone 4.\",\"ManufacturerName\":\"Apple\",\"ManufacturerSku\":\"ABC123\",\"Model\":\"iPhone 6\",\"PricingAndPurchasingLocations\":[{\"AllowReturns\":true,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"LockMinMaxed\":true,\"Margin\":1,\"MaximumQuantity\":10,\"MinimumQuantity\":1,\"MsrpAmount\":499.99,\"MsrpCurrencyCode\":\"USD\",\"Price\":499.99,\"PrimaryVendorName\":\"Apple\",\"RefundPeriod\":10,\"RefundToUsed\":false,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"iPhone 4S 16GB White\",\"ReleaseDate\":\"2011-10-14T12:00:00.000\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Better than the iPhone 3G\",\"Vendors\":[{\"Cost\":0,\"DiscontinuedDate\":\"2016-01-01T12:00:00.000\",\"DoNotOrder\":false,\"EndOfLife\":\"2016-01-01T12:00:00.000\",\"SpecialOrder\":false,\"VendorName\":\"SampleVendor\",\"VendorSku\":\"DEF987\",\"WriteOff\":false}],\"WarehouseLocation\":\"Cornwall\"}]}";

response = RestClient.post 'https://platformepcdemo.iqmetrix.net/v1/companies(1)/Products', body, {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
     :'Content-Type' => 'application/json',
    } 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Status": "/v1/companies(21090)/batchStatus(123)",
    "TimestampUTC": "2016-11-15T16:43:15.1396674Z"
}

Importing Non-Stocked Products into RQ

Request

POST /companies({CompanyId})/products/

Example Request

POST /companies(1)/products/
Authorization: Bearer (Access Token)
Accept: application/json
Content-Type: application/json

{
    "NonStockedProducts": [
        {
            "ProductName": "Prepaid Rate Plan",
            "CategoryName": "Rate Plans > Rate Plans",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "FloorPrice": 0,
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Prepaid plan forpeople on the go",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "Prepaid Rate Plan",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Prepaid plan",
            "VendorSku": "DEF987"
        }
    ]
}
curl -X POST "https://platformepcdemo.iqmetrix.net/v1/companies(1)/products/" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
    "NonStockedProducts": [
        {
            "ProductName": "Prepaid Rate Plan",
            "CategoryName": "Rate Plans > Rate Plans",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "FloorPrice": 0,
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Prepaid plan forpeople on the go",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "Prepaid Rate Plan",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Prepaid plan",
            "VendorSku": "DEF987"
        }
    ]
}'
static IRestResponse ImportingNon-stockedProductsIntoRq()
{
    var client = new RestClient("https://platformepcdemo.iqmetrix.net/v1/companies(1)/products/");
    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", "{\"NonStockedProducts\":[{\"ProductName\":\"Prepaid Rate Plan\",\"CategoryName\":\"Rate Plans > Rate Plans\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Prepaid plan forpeople on the go\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Prepaid Rate Plan\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Prepaid plan\",\"VendorSku\":\"DEF987\"}]}", 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 ImportingNon-stockedProductsIntoRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://platformepcdemo.iqmetrix.net/v1/companies(1)/products/");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"NonStockedProducts\":[{\"ProductName\":\"Prepaid Rate Plan\",\"CategoryName\":\"Rate Plans > Rate Plans\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Prepaid plan forpeople on the go\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Prepaid Rate Plan\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Prepaid plan\",\"VendorSku\":\"DEF987\"}]}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"NonStockedProducts\":[{\"ProductName\":\"Prepaid Rate Plan\",\"CategoryName\":\"Rate Plans > Rate Plans\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Prepaid plan forpeople on the go\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Prepaid Rate Plan\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Prepaid plan\",\"VendorSku\":\"DEF987\"}]}";

response = RestClient.post 'https://platformepcdemo.iqmetrix.net/v1/companies(1)/products/', body, {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
     :'Content-Type' => 'application/json',
    } 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Status": "/v1/companies(21090)/batchStatus(123)",
    "TimestampUTC": "2016-11-15T16:43:15.1396674Z"
}

Importing Non-Revenue Products into RQ

Request

POST /companies({CompanyId})/Products/

Example Request

POST /companies(1)/Products/
Authorization: Bearer (Access Token)
Accept: application/json
Content-Type: application/json

{
    "NonRevenueProducts": [
        {
            "ProductName": "Recycling Fee",
            "CategoryName": "Misc > Misc. Fees",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "FloorPrice": 0,
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Recycling fee to disposeof old handset",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "Recycling Fee",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Recycling fee",
            "VendorSku": "DEF987"
        }
    ]
}
curl -X POST "https://platformepcdemo.iqmetrix.net/v1/companies(1)/Products/" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
    "NonRevenueProducts": [
        {
            "ProductName": "Recycling Fee",
            "CategoryName": "Misc > Misc. Fees",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "FloorPrice": 0,
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Recycling fee to disposeof old handset",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "Recycling Fee",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "Recycling fee",
            "VendorSku": "DEF987"
        }
    ]
}'
static IRestResponse ImportingNon-revenueProductsIntoRq()
{
    var client = new RestClient("https://platformepcdemo.iqmetrix.net/v1/companies(1)/Products/");
    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", "{\"NonRevenueProducts\":[{\"ProductName\":\"Recycling Fee\",\"CategoryName\":\"Misc > Misc. Fees\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Recycling fee to disposeof old handset\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Recycling Fee\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Recycling fee\",\"VendorSku\":\"DEF987\"}]}", 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 ImportingNon-revenueProductsIntoRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://platformepcdemo.iqmetrix.net/v1/companies(1)/Products/");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"NonRevenueProducts\":[{\"ProductName\":\"Recycling Fee\",\"CategoryName\":\"Misc > Misc. Fees\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Recycling fee to disposeof old handset\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Recycling Fee\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Recycling fee\",\"VendorSku\":\"DEF987\"}]}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"NonRevenueProducts\":[{\"ProductName\":\"Recycling Fee\",\"CategoryName\":\"Misc > Misc. Fees\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"FloorPrice\":0,\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Recycling fee to disposeof old handset\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"Recycling Fee\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"Recycling fee\",\"VendorSku\":\"DEF987\"}]}";

response = RestClient.post 'https://platformepcdemo.iqmetrix.net/v1/companies(1)/Products/', body, {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
     :'Content-Type' => 'application/json',
    } 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Status": "/v1/companies(21090)/batchStatus(123)",
    "TimestampUTC": "2016-11-15T16:43:15.1396674Z"
}

Importing Vendor Rebates into RQ

Request

POST /Companies({CompanyId})/products

Example Request

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

{
    "VendorRebateProducts": [
        {
            "VendorName": "SampleVendor",
            "ProductName": "2 YR New Act",
            "CategoryName": "Rate Plans > Rate Plan Rebates",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Rebate on 2 year actiations",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "2 YR New Act",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "2 yr rebate",
            "VendorAccountName": "Verizon",
            "VendorSku": "DEF987"
        }
    ]
}
curl -X POST "https://platformepcdemo.iqmetrix.net/v1/Companies(1)/products" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
    "VendorRebateProducts": [
        {
            "VendorName": "SampleVendor",
            "ProductName": "2 YR New Act",
            "CategoryName": "Rate Plans > Rate Plan Rebates",
            "DefaultPricing": {
                "AllowReturns": true,
                "CarrierPrice": 0,
                "Cost": 0,
                "Discountable": true,
                "FloorPrice": 0,
                "ForSale": true,
                "InvoiceComments": "Invoice comment",
                "Margin": 1,
                "Price": 499.99,
                "RefundPeriod": 10,
                "ShowOnInvoice": true,
                "StoreInStorePrice": 399.99
            },
            "Enabled": true,
            "EnforcedTrackingNumberLength": 50,
            "ExtendedAttributes": [
                {
                    "Name": "ProductId",
                    "Value": "66"
                }
            ],
            "GlCostOfSalesAccountNumber": "1001",
            "GlInventoryAccountNumber": "1002",
            "GlSalesAccountNumber": "1003",
            "IgnoreAutomaticTaxAddition": false,
            "LongDescription": "Rebate on 2 year actiations",
            "PricingLocations": [
                {
                    "AllowReturns": true,
                    "CarrierPrice": 0,
                    "Cost": 0,
                    "Discountable": true,
                    "FloorPrice": 0,
                    "ForSale": true,
                    "InvoiceComments": "Invoice comment",
                    "Margin": 1,
                    "Price": 499.99,
                    "SaleBeginDate": "2015-10-14T12:00:00.000",
                    "SaleEndDate": "2015-10-18T12:00:00.000",
                    "SalePrice": 399.99,
                    "ShowOnInvoice": true,
                    "RefundPeriod": 10,
                    "StoreInStorePrice": 399.99,
                    "TargetLocationName": "Saskatchewan",
                    "TargetLocationType": "RegionName"
                }
            ],
            "PricingMethod": "Fixed",
            "ProductLabel": "2 YR New Act",
            "Serialized": true,
            "SerialNumberPromptText": "Serial prompt text here",
            "ShortDescription": "2 yr rebate",
            "VendorAccountName": "Verizon",
            "VendorSku": "DEF987"
        }
    ]
}'
static IRestResponse ImportingVendorRebatesIntoRq()
{
    var client = new RestClient("https://platformepcdemo.iqmetrix.net/v1/Companies(1)/products");
    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", "{\"VendorRebateProducts\":[{\"VendorName\":\"SampleVendor\",\"ProductName\":\"2 YR New Act\",\"CategoryName\":\"Rate Plans > Rate Plan Rebates\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Rebate on 2 year actiations\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"2 YR New Act\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"2 yr rebate\",\"VendorAccountName\":\"Verizon\",\"VendorSku\":\"DEF987\"}]}", 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 ImportingVendorRebatesIntoRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://platformepcdemo.iqmetrix.net/v1/Companies(1)/products");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"VendorRebateProducts\":[{\"VendorName\":\"SampleVendor\",\"ProductName\":\"2 YR New Act\",\"CategoryName\":\"Rate Plans > Rate Plan Rebates\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Rebate on 2 year actiations\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"2 YR New Act\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"2 yr rebate\",\"VendorAccountName\":\"Verizon\",\"VendorSku\":\"DEF987\"}]}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"VendorRebateProducts\":[{\"VendorName\":\"SampleVendor\",\"ProductName\":\"2 YR New Act\",\"CategoryName\":\"Rate Plans > Rate Plan Rebates\",\"DefaultPricing\":{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"RefundPeriod\":10,\"ShowOnInvoice\":true,\"StoreInStorePrice\":399.99},\"Enabled\":true,\"EnforcedTrackingNumberLength\":50,\"ExtendedAttributes\":[{\"Name\":\"ProductId\",\"Value\":\"66\"}],\"GlCostOfSalesAccountNumber\":\"1001\",\"GlInventoryAccountNumber\":\"1002\",\"GlSalesAccountNumber\":\"1003\",\"IgnoreAutomaticTaxAddition\":false,\"LongDescription\":\"Rebate on 2 year actiations\",\"PricingLocations\":[{\"AllowReturns\":true,\"CarrierPrice\":0,\"Cost\":0,\"Discountable\":true,\"FloorPrice\":0,\"ForSale\":true,\"InvoiceComments\":\"Invoice comment\",\"Margin\":1,\"Price\":499.99,\"SaleBeginDate\":\"2015-10-14T12:00:00.000\",\"SaleEndDate\":\"2015-10-18T12:00:00.000\",\"SalePrice\":399.99,\"ShowOnInvoice\":true,\"RefundPeriod\":10,\"StoreInStorePrice\":399.99,\"TargetLocationName\":\"Saskatchewan\",\"TargetLocationType\":\"RegionName\"}],\"PricingMethod\":\"Fixed\",\"ProductLabel\":\"2 YR New Act\",\"Serialized\":true,\"SerialNumberPromptText\":\"Serial prompt text here\",\"ShortDescription\":\"2 yr rebate\",\"VendorAccountName\":\"Verizon\",\"VendorSku\":\"DEF987\"}]}";

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

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Status": "/v1/companies(21090)/batchStatus(123)",
    "TimestampUTC": "2016-11-15T16:43:15.1396674Z"
}

GET Status for a Batch

This request can be used to get the status of a request previously sent to EPC.

Request

GET /companies({CompanyId})/batchStatus({BatchId})

Example Request

GET /companies(1)/batchStatus(3)
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus(3)" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingStatusForABatch()
{
    var client = new RestClient("https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus(3)");
    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 GettingStatusForABatch() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus(3)");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus(3)', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "BatchId": 3,
    "CompanyId": 14146,
    "DateCreated": "2015-09-14T22:11:16.5670000Z",
    "FailedCount": 1,
    "PendingCount": 1,
    "Products": [
        {
            "ProductName": "Galaxy Note 6",
            "SourceRowNumber": 15,
            "StatusCode": 2,
            "StatusName": "Error",
            "ErrorMessage": "No matching RQ manufacturer found with the name appple"
        }
    ],
    "SourceFileName": "Products.xslx",
    "StatusCode": 3,
    "StatusName": "Completed",
    "SuccessfulCount": 1,
    "TotalProductCount": 2
}

BatchStatus

Cancelling a Batch

This request can only be used to cancel a request that has not started, i.e. where Status is 1 (Ready)

Request

POST /companies({CompanyId})/batchStatus({BatchId})

Example Request

POST /companies(1)/batchStatus(3)
Authorization: Bearer (Access Token)
Accept: application/json
Content-Type: application/json

{
    "StatusCode": 4
}
curl -X POST "https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus(3)" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
    "StatusCode": 4
}'
static IRestResponse CancellingABatch()
{
    var client = new RestClient("https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus(3)");
    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", "{\"StatusCode\":4}", 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 CancellingABatch() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus(3)");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"StatusCode\":4}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"StatusCode\":4}";

response = RestClient.post 'https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus(3)', body, {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
     :'Content-Type' => 'application/json',
    } 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json

GET All Batches

Request

GET /companies({CompanyId})/batchStatus

Example Request

GET /companies(1)/batchStatus
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingAllBatches()
{
    var client = new RestClient("https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus");
    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 GettingAllBatches() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://platformepcdemo.iqmetrix.net/v1/companies(1)/batchStatus', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Items": [
        {
            "BatchId": 3,
            "CompanyId": 14146,
            "DateCreated": "2015-09-14T22:11:16.5670000Z",
            "FailedCount": 1,
            "PendingCount": 1,
            "Products": [
                {
                    "ProductName": "Galaxy Note 6",
                    "SourceRowNumber": 15,
                    "StatusCode": 2,
                    "StatusName": "Error",
                    "ErrorMessage": "No matching RQ manufacturer found with the name appple"
                }
            ],
            "SourceFileName": "Products.xslx",
            "StatusCode": 3,
            "StatusName": "Completed",
            "SuccessfulCount": 1,
            "TotalProductCount": 2
        }
    ],
    "MetaData": {
        "TotalResults": 1
    }
}

ERRORS

HTTP Status Code Description How to Resolve
HTTP 400 VendorSku is required Ensure the Required Identifier for your configuration is provided in the request
HTTP 400 Barcode is required Ensure the Required Identifier for your configuration is provided in the request
HTTP 400 ManufacturerSku is required Ensure the Required Identifier for your configuration is provided in the request
HTTP 400 Request body does not match the model schema. The string was not recognized as a valid DateTime. There is an unknown word starting at index 0. Ensure DiscontinuedDate and other DateTime fields are set to null or a valid date time
HTTP 400 '{x}' must not be empty Ensure all required properties are provided
HTTP 500 Unable to bind to type Ensure request body schema matches documentation, in particular that DefaultPricing is of type Object
Was this page helpful?