POST api/AddressBook/SendDispatchNotifications

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
customerOrders		Collection of CustomerOrder	None.

Request Formats

application/json, text/json

Sample:

{
  "customerOrders": [
    {
      "customerId": 1,
      "orderIds": "sample string 2",
      "customerPhone": "sample string 3"
    },
    {
      "customerId": 1,
      "orderIds": "sample string 2",
      "customerPhone": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<SendDispatchNotifications xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <customerOrders>
    <CustomerOrder>
      <customerId>1</customerId>
      <customerPhone>sample string 3</customerPhone>
      <orderIds>sample string 2</orderIds>
    </CustomerOrder>
    <CustomerOrder>
      <customerId>1</customerId>
      <customerPhone>sample string 3</customerPhone>
      <orderIds>sample string 2</orderIds>
    </CustomerOrder>
  </customerOrders>
</SendDispatchNotifications>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2024/09/17 21:26:41",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>