POST api/V3/SuggestiveOrder

API allows company to upload Retailer wise SKU wise suggestive order qty in SFA for any order date Maximum 2000 in One request

Request Information

URI Parameters

None.

Body Parameters

Collection of V3.SuggestiveOrder
NameDescriptionTypeAdditional information
OutletErpId

Outlet ERP Id/ClientSide ID

 string

Required
SuggestiveOrderId

Suggestive Order Id

 string

Required
OrderDate

Order date

 date

Required
ProductErpId

Product Erp Id

 string

Required
SuggestiveQuantity

Suggestive Quantity

 integer

Required

Range: inclusive between 0 and 2147483647
SOH

Stock in hand

 integer

Required

Range: inclusive between 0 and 2147483647
SOCM

Sell out current month

 integer

Required

Range: inclusive between 0 and 2147483647
SOA

Sell out average

 integer

Required

Range: inclusive between 0 and 2147483647
SOBM

Sell out best month

 string

Required

String length: inclusive between 0 and 250
SICM

Sell in current month

 integer

Required

Range: inclusive between 0 and 2147483647
SIA

Sell in average

 integer

Required

Range: inclusive between 0 and 2147483647
SIBM

Sell in best month

 string

Required

String length: inclusive between 0 and 250
SOL6M

Sell out last 6 months

 integer

Range: inclusive between 0 and 2147483647
SOYTD

YTD Sell out

 integer

Range: inclusive between 0 and 2147483647
SIL6M

Sell in last 6 months

 integer

Range: inclusive between 0 and 2147483647
SIYTD

Sell in YTD

 integer

Range: inclusive between 0 and 2147483647
IsStockout

Is StockOut

 boolean

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "OutletErpId": "sample string 1",
    "SuggestiveOrderId": "sample string 2",
    "OrderDate": "2026-01-07T07:07:53.519605+00:00",
    "ProductErpId": "sample string 4",
    "SuggestiveQuantity": 5,
    "SOH": 6,
    "SOCM": 7,
    "SOA": 8,
    "SOBM": "sample string 9",
    "SICM": 10,
    "SIA": 11,
    "SIBM": "sample string 12",
    "SOL6M": 1,
    "SOYTD": 1,
    "SIL6M": 1,
    "SIYTD": 1,
    "IsStockout": true
  },
  {
    "OutletErpId": "sample string 1",
    "SuggestiveOrderId": "sample string 2",
    "OrderDate": "2026-01-07T07:07:53.519605+00:00",
    "ProductErpId": "sample string 4",
    "SuggestiveQuantity": 5,
    "SOH": 6,
    "SOCM": 7,
    "SOA": 8,
    "SOBM": "sample string 9",
    "SICM": 10,
    "SIA": 11,
    "SIBM": "sample string 12",
    "SOL6M": 1,
    "SOYTD": 1,
    "SIL6M": 1,
    "SIYTD": 1,
    "IsStockout": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfSuggestiveOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <SuggestiveOrderModel>
    <IsStockout>true</IsStockout>
    <OrderDate>2026-01-07T07:07:53.519605+00:00</OrderDate>
    <OutletErpId>sample string 1</OutletErpId>
    <ProductErpId>sample string 4</ProductErpId>
    <SIA>11</SIA>
    <SIBM>sample string 12</SIBM>
    <SICM>10</SICM>
    <SIL6M>1</SIL6M>
    <SIYTD>1</SIYTD>
    <SOA>8</SOA>
    <SOBM>sample string 9</SOBM>
    <SOCM>7</SOCM>
    <SOH>6</SOH>
    <SOL6M>1</SOL6M>
    <SOYTD>1</SOYTD>
    <SuggestiveOrderId>sample string 2</SuggestiveOrderId>
    <SuggestiveQuantity>5</SuggestiveQuantity>
  </SuggestiveOrderModel>
  <SuggestiveOrderModel>
    <IsStockout>true</IsStockout>
    <OrderDate>2026-01-07T07:07:53.519605+00:00</OrderDate>
    <OutletErpId>sample string 1</OutletErpId>
    <ProductErpId>sample string 4</ProductErpId>
    <SIA>11</SIA>
    <SIBM>sample string 12</SIBM>
    <SICM>10</SICM>
    <SIL6M>1</SIL6M>
    <SIYTD>1</SIYTD>
    <SOA>8</SOA>
    <SOBM>sample string 9</SOBM>
    <SOCM>7</SOCM>
    <SOH>6</SOH>
    <SOL6M>1</SOL6M>
    <SOYTD>1</SOYTD>
    <SuggestiveOrderId>sample string 2</SuggestiveOrderId>
    <SuggestiveQuantity>5</SuggestiveQuantity>
  </SuggestiveOrderModel>
</ArrayOfSuggestiveOrderModel>

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>