POST api/v2/importProducts

Import Products in the same way as Web Importing with selective Update information.

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

None.

Body Parameters

Importing information (List of products and selective Update information)

Name	Type	Additional information
EmployeeId	integer	None.
IsUpdateOnly	boolean	None.
ProductList	Collection of ProductImportLine	None.
SelectiveUpdateInfo	SelectiveUpdateInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "EmployeeId": 1,
  "IsUpdateOnly": true,
  "ProductList": [
    {
      "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": "2025-04-03T04:18:14.6077385-04:00",
      "SaleEndDate": "2025-04-03T04:18:14.6077385-04:00",
      "SalePrice": 1.0,
      "Discontinue": true,
      "SecondaryVendors": [
        {
          "SKU": "sample string 1",
          "VendorCode": "sample string 2",
          "Msrp": 1.0,
          "Cost": 1.0,
          "Delete": true,
          "IsPrimary": true,
          "PurchasingQty": 1.0,
          "PurchasingSku": "sample string 5",
          "PurchasingUnitCode": "sample string 6"
        },
        {
          "SKU": "sample string 1",
          "VendorCode": "sample string 2",
          "Msrp": 1.0,
          "Cost": 1.0,
          "Delete": true,
          "IsPrimary": true,
          "PurchasingQty": 1.0,
          "PurchasingSku": "sample string 5",
          "PurchasingUnitCode": "sample string 6"
        }
      ]
    },
    {
      "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": "2025-04-03T04:18:14.6077385-04:00",
      "SaleEndDate": "2025-04-03T04:18:14.6077385-04:00",
      "SalePrice": 1.0,
      "Discontinue": true,
      "SecondaryVendors": [
        {
          "SKU": "sample string 1",
          "VendorCode": "sample string 2",
          "Msrp": 1.0,
          "Cost": 1.0,
          "Delete": true,
          "IsPrimary": true,
          "PurchasingQty": 1.0,
          "PurchasingSku": "sample string 5",
          "PurchasingUnitCode": "sample string 6"
        },
        {
          "SKU": "sample string 1",
          "VendorCode": "sample string 2",
          "Msrp": 1.0,
          "Cost": 1.0,
          "Delete": true,
          "IsPrimary": true,
          "PurchasingQty": 1.0,
          "PurchasingSku": "sample string 5",
          "PurchasingUnitCode": "sample string 6"
        }
      ]
    }
  ],
  "SelectiveUpdateInfo": {
    "Name": true,
    "Sku": true,
    "ProductCode": true,
    "ServiceCode": true,
    "Price": true,
    "PriceUnit": true,
    "MemberPrice": true,
    "Cost": true,
    "StockQty": true,
    "QuickQties": true,
    "MinReorderPoint": true,
    "MaxReorderPoint": true,
    "PriceCanBeFree": true,
    "Category": true,
    "SecondaryCategories": true,
    "Vendor": true,
    "Brand": true,
    "TaxCategory": true,
    "ShortDescription": true,
    "Description": true,
    "Keywords": true,
    "Tags": true,
    "BinAisleNumber": true,
    "ProductAttributes": true,
    "AvailableShippingMethods": true,
    "QualifiedForInstallment": true,
    "AllowNegativeQtyInStorePickup": true,
    "NotForSale": true,
    "EnableSerialNumber": true,
    "DiscountCode": true,
    "SellOnline": true,
    "IsMatrix": true,
    "RevenueAccountCode": true,
    "InventoryAccountCode": true,
    "CogsAccountCode": true,
    "EbtQualified": true,
    "TrackInventory": true,
    "PurchasingStockUnit": true,
    "PurchasingQty": true,
    "PurchasingSku": true,
    "Photos": true,
    "Weight": true,
    "Width": true,
    "Height": true,
    "Length": true,
    "EnableSubscription": true,
    "MembershipSubscriptionInfo": true,
    "ProductVariants": true,
    "ImpulseBuy": true,
    "PayByMembership": true,
    "ServiceTime": true,
    "Resource": true,
    "CompanionItem": true,
    "EcommerceQohTreshold": true,
    "QuickCheckout": true,
    "SaleStartDate": true,
    "SaleEndDate": true,
    "SalePrice": true,
    "Discontinue": true
  }
}

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.