POST api/V3/Distributor/StockCaping/{DistributorERPId}

Upload the stock caping for a distributors

Request Information

URI Parameters

NameDescriptionTypeAdditional information
DistributorERPId

Guid or ERP id of the distributor

 string

Required

Body Parameters

Stock of this distributor

Collection of SecondaryCategoryStock
NameDescriptionTypeAdditional information
EntityType

SecondaryOrderEntityType

None.
EntityERPID

string

None.
QuantityInUnits

integer

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "EntityType": "SecondaryCategory",
    "EntityERPID": "sample string 1",
    "QuantityInUnits": 2
  },
  {
    "EntityType": "SecondaryCategory",
    "EntityERPID": "sample string 1",
    "QuantityInUnits": 2
  }
]

application/xml, text/xml

Sample: 
<ArrayOfSecondaryCategoryStock xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Controllers">
  <SecondaryCategoryStock>
    <EntityERPID>sample string 1</EntityERPID>
    <EntityType>SecondaryCategory</EntityType>
    <QuantityInUnits>2</QuantityInUnits>
  </SecondaryCategoryStock>
  <SecondaryCategoryStock>
    <EntityERPID>sample string 1</EntityERPID>
    <EntityType>SecondaryCategory</EntityType>
    <QuantityInUnits>2</QuantityInUnits>
  </SecondaryCategoryStock>
</ArrayOfSecondaryCategoryStock>

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>