POST api/V3/Category/ChangeCategoryForProduct

Change Category of Product

Request Information

URI Parameters

None.

Body Parameters

Collection of V3.ChangeCategoryModel
NameDescriptionTypeAdditional information
ProductDivision

Product Division of the product. (Mandatory if PrimaryCategory provided)

string

None.

PrimaryCategory

Primary Category of the product. (Mandatory if ProductDivision provided)

string

None.

Category

Category or Secondary Category or SKU Group Name

string

Required

ProductErpId

ErpId of the Product

string

Required

Request Formats

application/json, text/json

Sample:
[
  {
    "ProductDivision": "sample string 1",
    "PrimaryCategory": "sample string 2",
    "Category": "sample string 3",
    "ProductErpId": "sample string 4"
  },
  {
    "ProductDivision": "sample string 1",
    "PrimaryCategory": "sample string 2",
    "Category": "sample string 3",
    "ProductErpId": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfChangeCategoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <ChangeCategoryModel>
    <Category>sample string 3</Category>
    <PrimaryCategory>sample string 2</PrimaryCategory>
    <ProductDivision>sample string 1</ProductDivision>
    <ProductErpId>sample string 4</ProductErpId>
  </ChangeCategoryModel>
  <ChangeCategoryModel>
    <Category>sample string 3</Category>
    <PrimaryCategory>sample string 2</PrimaryCategory>
    <ProductDivision>sample string 1</ProductDivision>
    <ProductErpId>sample string 4</ProductErpId>
  </ChangeCategoryModel>
</ArrayOfChangeCategoryModel>

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
Message

Message Indicating the Overall Response Summary of the Requested API

string

None.

ResponseList

List of Errors

Collection of ApiResponseMessage

None.

Response

Enum Indicating the Response status

ResponseStatus

None.

ResponseStatusCount

Summary containing Number of SuccessFull And Failed Tasks

ResponseStatusCount

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "ResponseList": [
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    },
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    }
  ],
  "Response": "Failure",
  "ResponseStatusCount": {
    "Updated": 1,
    "Failed": 2,
    "Ignored": 3,
    "Name": "sample string 1",
    "Total": 6,
    "StatusMessage": "sample string 1: Total-6, Updated-1, Failed-2, Ignored-3",
    "ResponseStatus": "PartialSuccess"
  }
}

application/xml, text/xml

Sample:
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <Message>sample string 1</Message>
  <Response>Failure</Response>
  <ResponseList>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
  </ResponseList>
  <ResponseStatusCount>
    <Failed>2</Failed>
    <Ignored>3</Ignored>
    <Name>sample string 1</Name>
    <Updated>1</Updated>
  </ResponseStatusCount>
</ApiResponse>