PUT v1/ProductCategories

BETA

Updates Product Categories. **This endpoint is in BETA.**

Request Information

URI Parameters

None.

Body Parameters

Leave fields empty to clear them, null fields will not be updated

Collection of UpdateProductCategoryRequest
NameDescriptionTypeAdditional information

Id

integer

Range: inclusive between 1 and 2147483647

Name

string

Max length: 50

Description

string

Max length: 250

ParentId

Category Id of the parent category. 0 for root category (or to unlink from parent). null to not update.

integer

Range: inclusive between 0 and 2147483647

Sort

integer

Range: inclusive between 0 and 2147483647

Request Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "parentId": 1,
    "sort": 1
  },
  {
    "id": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "parentId": 1,
    "sort": 1
  }
]

Response Information

Resource Description

Collection of BatchResultItem
NameDescriptionTypeAdditional 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": []
  }
]