POST {opco}/api/v1/Order/{orderId}/ShipmentStatus

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId		string	Required
opco		string	None.

Body Parameters

ShipmentStatus

Name	Type	Additional information
Status	DeliveryStep	None.
AdditionalNotes	string	None.
FreightAmount	decimal number	None.
DeliveryMethod	string	None.
TrackingURL	string	None.
TrackingNumber	string	None.

Request Formats

application/json, text/json

Sample:

{
  "status": 0,
  "additionalNotes": "sample string 1",
  "freightAmount": 2.0,
  "deliveryMethod": "sample string 3",
  "trackingURL": "sample string 4",
  "trackingNumber": "sample string 5"
}

application/xml, text/xml

Sample:

<ShipmentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.Orders.v1">
  <AdditionalNotes>sample string 1</AdditionalNotes>
  <DeliveryMethod>sample string 3</DeliveryMethod>
  <FreightAmount>2</FreightAmount>
  <Status>ReadyforDelivery</Status>
  <TrackingNumber>sample string 5</TrackingNumber>
  <TrackingURL>sample string 4</TrackingURL>
</ShipmentStatus>

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 'ShipmentStatus'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.