POST api/V3/Distributor/CreateWithPDs

Creates Distributor with Product Divsion Mappings

Request Information

URI Parameters

None.

Body Parameters

Distributors with PDs To be Added(Max 500)

Collection of V3.DistributorWithPDs
NameDescriptionTypeAdditional information
SuperStockistName

SuperStockist of the distributor

 string

String length: inclusive between 0 and 100
SuperStockistErpId

ErpId of the SuperStockist

 string

String length: inclusive between 0 and 100
ProductDivisons

List of Product Divison names

 Collection of string

Required
Name

Name of the distributor.

 string

Required
ContactNo

Contact no.

 string

Matching regular expression pattern: ^[1-9]\d{9}$
EmailId

Email Id

 string

Matching regular expression pattern: ^[\D][0-9a-zA-Z\._]{1,}\@[0-9a-zA-Z\._]{2,}\.[a-zA-Z]{2,}$
SecondaryEmailId

Secondary EmailId Id

 string

Matching regular expression pattern: ^[\D][0-9a-zA-Z\._]{1,}\@[0-9a-zA-Z\._]{2,}\.[a-zA-Z]{2,}$
Manager

NAme of The contact Person

 string

None.
DistributorERPId

ERP or SAP id for the distributor.

 string

Required
LocalName

Alternate/Local for the distributor.

 string

String length: inclusive between 0 and 100
Address

Address of the Location of the distributor

 string

None.
Place

Location/City of the distributor

 string

None.
GSTIN

GSTIN (Goods and Service Tax Identity Number) No.

 string

String length: inclusive between 0 and 20
Pincode

Pincode of the Locationof the distributor

 string

Matching regular expression pattern: ^[1-9]\d{4,5}$
Region

Region of the distributor

 string

Required
IsDeactive

Set if Distributor is deactive.. (Only for Updating) This Data will be Ignored if used during Distributor Creation

 boolean

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "SuperStockistName": "sample string 1",
    "SuperStockistErpId": "sample string 2",
    "ProductDivisons": [
      "sample string 1",
      "sample string 2"
    ],
    "Name": "sample string 3",
    "ContactNo": "sample string 4",
    "EmailId": "sample string 5",
    "SecondaryEmailId": "sample string 6",
    "Manager": "sample string 7",
    "DistributorERPId": "sample string 8",
    "LocalName": "sample string 9",
    "Address": "sample string 10",
    "Place": "sample string 11",
    "GSTIN": "sample string 12",
    "Pincode": "sample string 13",
    "Region": "sample string 14",
    "IsDeactive": true
  },
  {
    "SuperStockistName": "sample string 1",
    "SuperStockistErpId": "sample string 2",
    "ProductDivisons": [
      "sample string 1",
      "sample string 2"
    ],
    "Name": "sample string 3",
    "ContactNo": "sample string 4",
    "EmailId": "sample string 5",
    "SecondaryEmailId": "sample string 6",
    "Manager": "sample string 7",
    "DistributorERPId": "sample string 8",
    "LocalName": "sample string 9",
    "Address": "sample string 10",
    "Place": "sample string 11",
    "GSTIN": "sample string 12",
    "Pincode": "sample string 13",
    "Region": "sample string 14",
    "IsDeactive": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfDistributorWithPDs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <DistributorWithPDs>
    <Address>sample string 10</Address>
    <ContactNo>sample string 4</ContactNo>
    <DistributorERPId>sample string 8</DistributorERPId>
    <EmailId>sample string 5</EmailId>
    <GSTIN>sample string 12</GSTIN>
    <IsDeactive>true</IsDeactive>
    <LocalName>sample string 9</LocalName>
    <Manager>sample string 7</Manager>
    <Name>sample string 3</Name>
    <Pincode>sample string 13</Pincode>
    <Place>sample string 11</Place>
    <Region>sample string 14</Region>
    <SecondaryEmailId>sample string 6</SecondaryEmailId>
    <ProductDivisons xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ProductDivisons>
    <SuperStockistErpId>sample string 2</SuperStockistErpId>
    <SuperStockistName>sample string 1</SuperStockistName>
  </DistributorWithPDs>
  <DistributorWithPDs>
    <Address>sample string 10</Address>
    <ContactNo>sample string 4</ContactNo>
    <DistributorERPId>sample string 8</DistributorERPId>
    <EmailId>sample string 5</EmailId>
    <GSTIN>sample string 12</GSTIN>
    <IsDeactive>true</IsDeactive>
    <LocalName>sample string 9</LocalName>
    <Manager>sample string 7</Manager>
    <Name>sample string 3</Name>
    <Pincode>sample string 13</Pincode>
    <Place>sample string 11</Place>
    <Region>sample string 14</Region>
    <SecondaryEmailId>sample string 6</SecondaryEmailId>
    <ProductDivisons xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ProductDivisons>
    <SuperStockistErpId>sample string 2</SuperStockistErpId>
    <SuperStockistName>sample string 1</SuperStockistName>
  </DistributorWithPDs>
</ArrayOfDistributorWithPDs>

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>