POST ProductClassification/PostProductClassification

Add an Agvance Product Classification with optional assigned products.

Request Information

URI Parameters

Body Parameters

Product classification object to use for the creation of a classification with optional assigned products.

ClsApiProductClassification
NameDescriptionTypeAdditional Information
ClassificationName

The user assigned name of this Classification. Allows items of its type to be grouped or categorized by it.

 string

Required

Max length: 50
QuickSelect

Indicates whether or not this Classification is used to group its associated products for quick selection in Agvance. Only used with Product Classifications.

 boolean

Must be 0, 1, True, or False
Products

The list of products associated with the newly added clasification.

 Collection of ClsProductIdentifier

Request Formats

application/json, text/json

Sample: 
{
  "ClassificationName": "sample string 4",
  "QuickSelect": true,
  "Products": [
    {
      "ProductGUID": "375a6b56-3b4c-4261-a561-6aaf7c751344",
      "DepartmentID": "sample string 1",
      "ProductID": "sample string 2"
    },
    {
      "ProductGUID": "375a6b56-3b4c-4261-a561-6aaf7c751344",
      "DepartmentID": "sample string 1",
      "ProductID": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<ClsApiProductClassification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.API">
  <ClassificationName xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Classification">sample string 4</ClassificationName>
  <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Inventory" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Classification">
    <d2p1:ClsProduct.ClsProductIdentifier>
      <d2p1:DepartmentID>sample string 1</d2p1:DepartmentID>
      <d2p1:ProductGUID>375a6b56-3b4c-4261-a561-6aaf7c751344</d2p1:ProductGUID>
      <d2p1:ProductID>sample string 2</d2p1:ProductID>
    </d2p1:ClsProduct.ClsProductIdentifier>
    <d2p1:ClsProduct.ClsProductIdentifier>
      <d2p1:DepartmentID>sample string 1</d2p1:DepartmentID>
      <d2p1:ProductGUID>375a6b56-3b4c-4261-a561-6aaf7c751344</d2p1:ProductGUID>
      <d2p1:ProductID>sample string 2</d2p1:ProductID>
    </d2p1:ClsProduct.ClsProductIdentifier>
  </Products>
  <QuickSelect xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Classification">true</QuickSelect>
</ClsApiProductClassification>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsApiProductClassification'.

Response Information

Resource Description

Add an Agvance Product Classification with optional assigned products.

AgvanceProductClassification
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

 string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

 string
ErrorList

List of errors from the API

 Collection of string
WarningList

List of warnings from the API

 Collection of string
MasterClassNamesKey

The auto-assigned key of this Classification

 integer

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "MasterClassNamesKey": 3
}

application/xml, text/xml

Sample: 
<AgvanceProductClassification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.ProductClassification">
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <MasterClassNamesKey>3</MasterClassNamesKey>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvanceProductClassification>