POST api/V3/Visit/rejectedOrders

Accepts rejected orders

Request Information

URI Parameters

None.

Body Parameters

Collection of RejectedOrderRequest
NameDescriptionTypeAdditional information
VisitId

Visist id for which sync fails

integer

Required

RejectionRemark

Reason of the order not getting fetched

string

Required

String length: inclusive between 0 and 100

RejectionTime

Time at which the order could not be fetched. Format yyyy-mm-dd hh:mm:ss e.g. 2018-03-13 14:28:31

date

Required

Request Formats

application/json, text/json

Sample:
[
  {
    "VisitId": 1,
    "RejectionRemark": "sample string 2",
    "RejectionTime": "2026-01-07T07:10:00.5039173+00:00"
  },
  {
    "VisitId": 1,
    "RejectionRemark": "sample string 2",
    "RejectionTime": "2026-01-07T07:10:00.5039173+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRejectedOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <RejectedOrderRequest>
    <RejectionRemark>sample string 2</RejectionRemark>
    <RejectionTime>2026-01-07T07:10:00.5039173+00:00</RejectionTime>
    <VisitId>1</VisitId>
  </RejectedOrderRequest>
  <RejectedOrderRequest>
    <RejectionRemark>sample string 2</RejectionRemark>
    <RejectionTime>2026-01-07T07:10:00.5039173+00:00</RejectionTime>
    <VisitId>1</VisitId>
  </RejectedOrderRequest>
</ArrayOfRejectedOrderRequest>

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>