POST api/importProducts?employeeId={employeeId}&updateCost={updateCost}&updateDescription={updateDescription}&updateStock={updateStock}&updatePrice={updatePrice}

Import Products in the same way as Web Importing.

Request Information

Allows multi-location processing, in case of using parent location token restrictByLocations parameter is strongly recommended with comma separated list of locations to select from or update in

URI Parameters

Name	Description	Type	Additional information
employeeId	Required	integer	Required
updateCost		boolean	Default value is True
updateDescription		boolean	Default value is True
updateStock		boolean	Default value is True
updatePrice		boolean	Default value is True

Body Parameters

List of products

Collection of ProductImportLine

Name	Type	Additional information
CompanyId	integer	None.
AllowShip	boolean	None.
AddSerialNumber	boolean	None.
QualifiedForInstallment	boolean	None.
PriceCanBeFree	boolean	None.
AllowNegativeInventory	boolean	None.
NotForSale	boolean	None.
Name	string	Required
SKU	string	None.
ProductCode	string	None.
Price	decimal number	Required
PriceUnit	integer	None.
MemberPrice	decimal number	None.
Cost	decimal number	Required
Stock	decimal number	None.
MinReorderPoint	decimal number	None.
MaxReorderPoint	decimal number	None.
ShortDescription	string	None.
Description	string	None.
Keywords	string	None.
Tags	string	None.
BinNumber	string	None.
AttributeName	string	None.
AttributeAdditionalAmount	decimal number	None.
Category	string	Required
CategoryCode	string	None.
VendorName	string	None.
VendorCode	string	None.
BrandName	string	None.
BrandCode	string	None.
TaxCategory	string	None.
AttributeType	string	None.
QuickCheckout	boolean	None.
AddToDiscountCategory	string	None.
AddToDiscountBySKU	string	None.
SellOnline	boolean	None.
IsMatrix	boolean	None.
RevenueAccountCode	string	None.
InventoryAccountCode	string	None.
COGSAccountCode	string	None.
EbtQualified	boolean	None.
TrackInventory	boolean	None.
Weight	decimal number	None.
Width	decimal number	None.
Height	decimal number	None.
Length	decimal number	None.
PurchasingQty	decimal number	None.
ImageUrl	string	None.
AdditionalImageUrl1	string	None.
AdditionalImageUrl2	string	None.
AdditionalImageUrl3	string	None.
AllowDeliver	boolean	None.
AllowPickup	boolean	None.
EnableSubscription	boolean	None.
SubscriptionFrequency	string	None.
SubscriptionPeriod	integer	None.
ProductVariants	string	None.
ImpulseBuy	string	None.
PayByMembership	boolean	None.
PurchasingSku	string	None.
EcommerceQohTreshold	decimal number	None.
PreviousSku	string	None.
QuickQuantities	string	None.
SaleStartDate	date	None.
SaleEndDate	date	None.
SalePrice	decimal number	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "CompanyId": 1,
    "AllowShip": true,
    "AddSerialNumber": true,
    "QualifiedForInstallment": true,
    "PriceCanBeFree": true,
    "AllowNegativeInventory": true,
    "NotForSale": true,
    "Name": "sample string 7",
    "SKU": "sample string 8",
    "ProductCode": "sample string 9",
    "Price": 1.0,
    "PriceUnit": 1,
    "MemberPrice": 1.0,
    "Cost": 1.0,
    "Stock": 1.0,
    "MinReorderPoint": 1.0,
    "MaxReorderPoint": 1.0,
    "ShortDescription": "sample string 10",
    "Description": "sample string 11",
    "Keywords": "sample string 12",
    "Tags": "sample string 13",
    "BinNumber": "sample string 14",
    "AttributeName": "sample string 15",
    "AttributeAdditionalAmount": 1.0,
    "Category": "sample string 16",
    "CategoryCode": "sample string 17",
    "VendorName": "sample string 18",
    "VendorCode": "sample string 19",
    "BrandName": "sample string 20",
    "BrandCode": "sample string 21",
    "TaxCategory": "sample string 22",
    "AttributeType": "sample string 23",
    "QuickCheckout": true,
    "AddToDiscountCategory": "sample string 25",
    "AddToDiscountBySKU": "sample string 26",
    "SellOnline": true,
    "IsMatrix": true,
    "RevenueAccountCode": "sample string 29",
    "InventoryAccountCode": "sample string 30",
    "COGSAccountCode": "sample string 31",
    "EbtQualified": true,
    "TrackInventory": true,
    "Weight": 34.0,
    "Width": 35.0,
    "Height": 36.0,
    "Length": 37.0,
    "PurchasingQty": 1.0,
    "ImageUrl": "sample string 38",
    "AdditionalImageUrl1": "sample string 39",
    "AdditionalImageUrl2": "sample string 40",
    "AdditionalImageUrl3": "sample string 41",
    "AllowDeliver": true,
    "AllowPickup": true,
    "EnableSubscription": true,
    "SubscriptionFrequency": "sample string 45",
    "SubscriptionPeriod": 1,
    "ProductVariants": "sample string 46",
    "ImpulseBuy": "sample string 47",
    "PayByMembership": true,
    "PurchasingSku": "sample string 51",
    "EcommerceQohTreshold": 1.0,
    "PreviousSku": "sample string 52",
    "QuickQuantities": "sample string 53",
    "SaleStartDate": "2024-10-18T01:19:57.7409873-04:00",
    "SaleEndDate": "2024-10-18T01:19:57.7409873-04:00",
    "SalePrice": 1.0
  },
  {
    "CompanyId": 1,
    "AllowShip": true,
    "AddSerialNumber": true,
    "QualifiedForInstallment": true,
    "PriceCanBeFree": true,
    "AllowNegativeInventory": true,
    "NotForSale": true,
    "Name": "sample string 7",
    "SKU": "sample string 8",
    "ProductCode": "sample string 9",
    "Price": 1.0,
    "PriceUnit": 1,
    "MemberPrice": 1.0,
    "Cost": 1.0,
    "Stock": 1.0,
    "MinReorderPoint": 1.0,
    "MaxReorderPoint": 1.0,
    "ShortDescription": "sample string 10",
    "Description": "sample string 11",
    "Keywords": "sample string 12",
    "Tags": "sample string 13",
    "BinNumber": "sample string 14",
    "AttributeName": "sample string 15",
    "AttributeAdditionalAmount": 1.0,
    "Category": "sample string 16",
    "CategoryCode": "sample string 17",
    "VendorName": "sample string 18",
    "VendorCode": "sample string 19",
    "BrandName": "sample string 20",
    "BrandCode": "sample string 21",
    "TaxCategory": "sample string 22",
    "AttributeType": "sample string 23",
    "QuickCheckout": true,
    "AddToDiscountCategory": "sample string 25",
    "AddToDiscountBySKU": "sample string 26",
    "SellOnline": true,
    "IsMatrix": true,
    "RevenueAccountCode": "sample string 29",
    "InventoryAccountCode": "sample string 30",
    "COGSAccountCode": "sample string 31",
    "EbtQualified": true,
    "TrackInventory": true,
    "Weight": 34.0,
    "Width": 35.0,
    "Height": 36.0,
    "Length": 37.0,
    "PurchasingQty": 1.0,
    "ImageUrl": "sample string 38",
    "AdditionalImageUrl1": "sample string 39",
    "AdditionalImageUrl2": "sample string 40",
    "AdditionalImageUrl3": "sample string 41",
    "AllowDeliver": true,
    "AllowPickup": true,
    "EnableSubscription": true,
    "SubscriptionFrequency": "sample string 45",
    "SubscriptionPeriod": 1,
    "ProductVariants": "sample string 46",
    "ImpulseBuy": "sample string 47",
    "PayByMembership": true,
    "PurchasingSku": "sample string 51",
    "EcommerceQohTreshold": 1.0,
    "PreviousSku": "sample string 52",
    "QuickQuantities": "sample string 53",
    "SaleStartDate": "2024-10-18T01:19:57.7409873-04:00",
    "SaleEndDate": "2024-10-18T01:19:57.7409873-04:00",
    "SalePrice": 1.0
  }
]

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EmployeeId - for each messages, CompanyId - when error, warning or message related to company, IsSuccess - true in case if it's message about successful import or false if there is error or warning, ErrorCode - if there is error or warning, determine generic description of trouble, Message - in case if there is error or warning with text explanation of situation, InvalidLines - for pre-validation and if there are errors in importing process related to specific line. Format is [line number], [List of errors] Updated, Inserted, Total - is quantites, only if case of success import. If you see Total less then quantity you sent, check your input data to be sure there no errors and SKU is not repeated.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.