POST api/v1/orders/update

Request Information

URI Parameters

None.

Body Parameters

OrderShipmentWebHookModel
NameDescriptionTypeAdditional information
event

Collection of Object

None.

driver

Collection of Object

None.

shipment

Collection of Object

None.

order

Collection of Object

None.

Request Formats

application/json, text/json

Sample:
{
  "event": null,
  "driver": null,
  "shipment": null,
  "order": null
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderShipmentWebHookModel'.

Response Information

Resource Description

MovamApiResponse
NameDescriptionTypeAdditional information
Message

string

None.

Data

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Data": {}
}

application/xml, text/xml

Sample:
<MovamApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model.Movam">
  <Data />
  <Message>sample string 1</Message>
</MovamApiResponse>