PUT v1/Products

BETA

Updates a list of Products. If a product with the same style code or product option code already exists, it will be skipped and not updated. Leave fields empty to clear them, leave fields null to not update them. **This endpoint is in BETA.**

Request Information

URI Parameters

None.

Body Parameters

Collection of UpdateProductRequest

Name	Description	Type	Additional information
Id		integer	Required Range: inclusive between 1 and 2147483647
Name		string	Max length: 50 Min length: 2
Status	Will default to Public if not set. Status: Public, Inactive, ShowInB2B, Internal	ProductStatus	None.
Description		string	Max length: 250
StyleCode		string	Max length: 250
Brand	The product brand name. Allow users to assign a brand name based on their preference. This doesn’t need to be part of the existing list of brands present in the backend.	string	Max length: 250
OptionLabel1	A label for the first product option (e.g., Color).	string	Max length: 250
OptionLabel2	A label for the second product option (e.g., Size).	string	Max length: 250
OptionLabel3	A label for the third product option (e.g., Fabric).	string	Max length: 250
SalesAccount	The sales account associated with the product.	string	Max length: 250
PurchasesAccount	The purchase account associated with the product.	string	Max length: 250
ImportCustomsDuty	The import customs duty applicable to the product.	string	Max length: 250
SkuRangeId	The id of the SKU Range available in Omni account.	integer	None.
CategoryIdArray	Array of category IDs assigned to the product.	Collection of integer	None.
ProductDimensions		UpdateProductDimensionsRequest	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "status": "Inactive",
    "description": "sample string 3",
    "styleCode": "sample string 4",
    "brand": "sample string 5",
    "optionLabel1": "sample string 6",
    "optionLabel2": "sample string 7",
    "optionLabel3": "sample string 8",
    "salesAccount": "sample string 9",
    "purchasesAccount": "sample string 10",
    "importCustomsDuty": "sample string 11",
    "skuRangeId": 1,
    "categoryIdArray": [
      1,
      2
    ],
    "productDimensions": {
      "weight": 1.0,
      "height": 1.0,
      "width": 1.0,
      "length": 1.0,
      "volume": 1.0
    }
  },
  {
    "id": 1,
    "name": "sample string 2",
    "status": "Inactive",
    "description": "sample string 3",
    "styleCode": "sample string 4",
    "brand": "sample string 5",
    "optionLabel1": "sample string 6",
    "optionLabel2": "sample string 7",
    "optionLabel3": "sample string 8",
    "salesAccount": "sample string 9",
    "purchasesAccount": "sample string 10",
    "importCustomsDuty": "sample string 11",
    "skuRangeId": 1,
    "categoryIdArray": [
      1,
      2
    ],
    "productDimensions": {
      "weight": 1.0,
      "height": 1.0,
      "width": 1.0,
      "length": 1.0,
      "volume": 1.0
    }
  }
]

Response Information

Resource Description

Collection of BatchResultItem

Name	Description	Type	Additional information
Index	The index at which the record was positioned in an insert or update.	integer	None.
Success	True if the record was successfully inserted or updated.	boolean	None.
Id	The record Id.	integer	None.
Code	The record code.	string	None.
Errors	A list of errors if the insert or update fails.	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "index": 0,
    "success": true,
    "id": 1,
    "code": "SALE4-28",
    "errors": []
  },
  {
    "index": 1,
    "success": true,
    "id": 2,
    "code": "SALE5-29",
    "errors": []
  }
]