POST api/V3/Schemes/CreateMultiple

API to create multiple schemes

Request Information

URI Parameters

None.

Body Parameters

List of schemes to be added(Max 100)

Collection of V3.SchemeCreate

Name	Description	Type	Additional information
SchemeName	Name of the Scheme	string	Required
SchemeERPId	ERP ID of the Scheme	string	None.
StartDate	Start Date of Scheme	date	Required
EndDate	End Date of Scheme	date	Required
SchemeCategory	Scheme Category: "Primary"=1, "Secondary"=2, "Tertiary"=3, "Uncategorised"=0	SchemeCategorization	Required
SchemeDescription	Description of the Scheme getting created	string	None.
PayOutType	PayOut Type of Scheme: "Discount", "FOC", "FixedValueDiscount"	PayoutType	Required
PayOutCalculationType	Calculation Type: "Step"=1, "Continous"=2, "Recurring=4"	PayoutCalculationType	Required
ConstraintOn	Constraint On: "Amount"=1, "Quantity"=2, "Standard_Unit"=3	ConstraintType	Required
PayOutIn	PayOut in: "Amount"=1, "Quantity"=2, "Standard_Unit"=3 (Valid for Payout: FOC)	PayoutIn	None.
SchemeBudget	Budget of Schemes	decimal number	None.
ApplicableAtLevel	Scheme is Applicable on: "Company"=0, "Zone"=1, "Region"=2, "Distributor"=3	SchemeApplicableAtLevel	Required
ApplicableOnEntity	Multiple Region Names, Zone Names, or Distributor ERPIDs in which Scheme is to be applied	Collection of string	Required
SchemeOn		DiscountBlock	Required
SchemeOnEntity	Multiple Product or Category names in which scheme is to be applied	Collection of string	Required
EligibleOn		DiscountBlock	None.
EligibleOnEntity	Multiple Product or Category names in which scheme is to be applied	Collection of string	None.
SchemeType	Primary = 1, Secondary = 2,	SchemeType	None.
SchemeSubType1	NonExtendable = 1, NonExtendableCompanytoSSandStockistonly = 2	SchemeSubType	None.
SchemeSubType2	Claimable = 3, NonClaimable = 4	SchemeSubType	None.
IsInclusive	Is Inclusive	boolean	None.
OutletConstraints	Outlet Constraints	SchemeOutletConstraintDb	None.
ProductFilterConstraints	Product Filter Constraints (for the Products defined in the "Scheme On Entity")	SchemeProductFilterConstraintDb	None.
SchemeSlabs		Collection of V3.SchemeSlabCreate	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "SchemeName": "sample string 1",
    "SchemeERPId": "sample string 2",
    "StartDate": "2025-04-08T11:37:49.4119595+00:00",
    "EndDate": "2025-04-08T11:37:49.4119595+00:00",
    "SchemeCategory": "Uncategorized",
    "SchemeDescription": "sample string 5",
    "PayOutType": "FOC",
    "PayOutCalculationType": "None",
    "ConstraintOn": "None",
    "PayOutIn": "Amount",
    "SchemeBudget": 1.1,
    "ApplicableAtLevel": "Company",
    "ApplicableOnEntity": [
      "sample string 1",
      "sample string 2"
    ],
    "SchemeOn": "Primary_Category",
    "SchemeOnEntity": [
      "sample string 1",
      "sample string 2"
    ],
    "EligibleOn": "Primary_Category",
    "EligibleOnEntity": [
      "sample string 1",
      "sample string 2"
    ],
    "SchemeType": "Primary",
    "SchemeSubType1": "Extendable",
    "SchemeSubType2": "Extendable",
    "IsInclusive": true,
    "OutletConstraints": {
      "RequiredIsFocused": true,
      "RequiredChannels": [
        "sample string 1",
        "sample string 2"
      ],
      "RequiredSegmentations": [
        "sample string 1",
        "sample string 2"
      ],
      "RequiredShopTypes": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "ProductFilterConstraints": {
      "MRP": [
        "sample string 1",
        "sample string 2"
      ],
      "PTR": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "SchemeSlabs": [
      {
        "ConstraintValue": 1.1,
        "Payout": 2.1,
        "PayoutDescription": "sample string 3",
        "PayoutProductERPID": "sample string 4"
      },
      {
        "ConstraintValue": 1.1,
        "Payout": 2.1,
        "PayoutDescription": "sample string 3",
        "PayoutProductERPID": "sample string 4"
      }
    ]
  },
  {
    "SchemeName": "sample string 1",
    "SchemeERPId": "sample string 2",
    "StartDate": "2025-04-08T11:37:49.4119595+00:00",
    "EndDate": "2025-04-08T11:37:49.4119595+00:00",
    "SchemeCategory": "Uncategorized",
    "SchemeDescription": "sample string 5",
    "PayOutType": "FOC",
    "PayOutCalculationType": "None",
    "ConstraintOn": "None",
    "PayOutIn": "Amount",
    "SchemeBudget": 1.1,
    "ApplicableAtLevel": "Company",
    "ApplicableOnEntity": [
      "sample string 1",
      "sample string 2"
    ],
    "SchemeOn": "Primary_Category",
    "SchemeOnEntity": [
      "sample string 1",
      "sample string 2"
    ],
    "EligibleOn": "Primary_Category",
    "EligibleOnEntity": [
      "sample string 1",
      "sample string 2"
    ],
    "SchemeType": "Primary",
    "SchemeSubType1": "Extendable",
    "SchemeSubType2": "Extendable",
    "IsInclusive": true,
    "OutletConstraints": {
      "RequiredIsFocused": true,
      "RequiredChannels": [
        "sample string 1",
        "sample string 2"
      ],
      "RequiredSegmentations": [
        "sample string 1",
        "sample string 2"
      ],
      "RequiredShopTypes": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "ProductFilterConstraints": {
      "MRP": [
        "sample string 1",
        "sample string 2"
      ],
      "PTR": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "SchemeSlabs": [
      {
        "ConstraintValue": 1.1,
        "Payout": 2.1,
        "PayoutDescription": "sample string 3",
        "PayoutProductERPID": "sample string 4"
      },
      {
        "ConstraintValue": 1.1,
        "Payout": 2.1,
        "PayoutDescription": "sample string 3",
        "PayoutProductERPID": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfSchemeCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <SchemeCreate>
    <ApplicableAtLevel>Company</ApplicableAtLevel>
    <ApplicableOnEntity xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ApplicableOnEntity>
    <ConstraintOn>None</ConstraintOn>
    <EligibleOn>Primary_Category</EligibleOn>
    <EligibleOnEntity xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EligibleOnEntity>
    <EndDate>2025-04-08T11:37:49.4119595+00:00</EndDate>
    <IsInclusive>true</IsInclusive>
    <OutletConstraints>
      <RequiredChannels xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </RequiredChannels>
      <RequiredIsFocused>true</RequiredIsFocused>
      <RequiredSegmentations xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </RequiredSegmentations>
      <RequiredShopTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </RequiredShopTypes>
    </OutletConstraints>
    <PayOutCalculationType>None</PayOutCalculationType>
    <PayOutIn>Amount</PayOutIn>
    <PayOutType>FOC</PayOutType>
    <ProductFilterConstraints>
      <MRP xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </MRP>
      <PTR xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </PTR>
    </ProductFilterConstraints>
    <SchemeBudget>1.1</SchemeBudget>
    <SchemeCategory>Uncategorized</SchemeCategory>
    <SchemeDescription>sample string 5</SchemeDescription>
    <SchemeERPId>sample string 2</SchemeERPId>
    <SchemeName>sample string 1</SchemeName>
    <SchemeOn>Primary_Category</SchemeOn>
    <SchemeOnEntity xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SchemeOnEntity>
    <SchemeSlabs>
      <SchemeSlabCreate>
        <ConstraintValue>1.1</ConstraintValue>
        <Payout>2.1</Payout>
        <PayoutDescription>sample string 3</PayoutDescription>
        <PayoutProductERPID>sample string 4</PayoutProductERPID>
      </SchemeSlabCreate>
      <SchemeSlabCreate>
        <ConstraintValue>1.1</ConstraintValue>
        <Payout>2.1</Payout>
        <PayoutDescription>sample string 3</PayoutDescription>
        <PayoutProductERPID>sample string 4</PayoutProductERPID>
      </SchemeSlabCreate>
    </SchemeSlabs>
    <SchemeSubType1>Extendable</SchemeSubType1>
    <SchemeSubType2>Extendable</SchemeSubType2>
    <SchemeType>Primary</SchemeType>
    <StartDate>2025-04-08T11:37:49.4119595+00:00</StartDate>
  </SchemeCreate>
  <SchemeCreate>
    <ApplicableAtLevel>Company</ApplicableAtLevel>
    <ApplicableOnEntity xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ApplicableOnEntity>
    <ConstraintOn>None</ConstraintOn>
    <EligibleOn>Primary_Category</EligibleOn>
    <EligibleOnEntity xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EligibleOnEntity>
    <EndDate>2025-04-08T11:37:49.4119595+00:00</EndDate>
    <IsInclusive>true</IsInclusive>
    <OutletConstraints>
      <RequiredChannels xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </RequiredChannels>
      <RequiredIsFocused>true</RequiredIsFocused>
      <RequiredSegmentations xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </RequiredSegmentations>
      <RequiredShopTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </RequiredShopTypes>
    </OutletConstraints>
    <PayOutCalculationType>None</PayOutCalculationType>
    <PayOutIn>Amount</PayOutIn>
    <PayOutType>FOC</PayOutType>
    <ProductFilterConstraints>
      <MRP xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </MRP>
      <PTR xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </PTR>
    </ProductFilterConstraints>
    <SchemeBudget>1.1</SchemeBudget>
    <SchemeCategory>Uncategorized</SchemeCategory>
    <SchemeDescription>sample string 5</SchemeDescription>
    <SchemeERPId>sample string 2</SchemeERPId>
    <SchemeName>sample string 1</SchemeName>
    <SchemeOn>Primary_Category</SchemeOn>
    <SchemeOnEntity xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SchemeOnEntity>
    <SchemeSlabs>
      <SchemeSlabCreate>
        <ConstraintValue>1.1</ConstraintValue>
        <Payout>2.1</Payout>
        <PayoutDescription>sample string 3</PayoutDescription>
        <PayoutProductERPID>sample string 4</PayoutProductERPID>
      </SchemeSlabCreate>
      <SchemeSlabCreate>
        <ConstraintValue>1.1</ConstraintValue>
        <Payout>2.1</Payout>
        <PayoutDescription>sample string 3</PayoutDescription>
        <PayoutProductERPID>sample string 4</PayoutProductERPID>
      </SchemeSlabCreate>
    </SchemeSlabs>
    <SchemeSubType1>Extendable</SchemeSubType1>
    <SchemeSubType2>Extendable</SchemeSubType2>
    <SchemeType>Primary</SchemeType>
    <StartDate>2025-04-08T11:37:49.4119595+00:00</StartDate>
  </SchemeCreate>
</ArrayOfSchemeCreate>

Response Information

Resource Description

Response Description with Error messages

ApiResponse

Name	Description	Type	Additional 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>

POST api/V3/Schemes/CreateMultiple

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body