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

Request Information

URI Parameters

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

Body Parameters

OrderDeliveryStatus

Name	Type	Additional information
Status	DeliveryStep	None.
ShippingCostActual	decimal number	None.
AdditionalNotes	string	None.
Image	string	None.
ImageFileType	string	None.
Signature	string	None.
SignatureFileType	string	None.
UpdateTime	date	None.

Request Formats

application/json, text/json

Sample:

{
  "status": 0,
  "shippingCostActual": 1.0,
  "additionalNotes": "sample string 2",
  "image": "sample string 3",
  "imageFileType": "sample string 4",
  "signature": "sample string 5",
  "signatureFileType": "sample string 6",
  "updateTime": "2024-10-01T02:36:09.5709942-12:00"
}

application/xml, text/xml

Sample:

<OrderDeliveryStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.Orders.v1">
  <AdditionalNotes>sample string 2</AdditionalNotes>
  <Image>sample string 3</Image>
  <ImageFileType>sample string 4</ImageFileType>
  <ShippingCostActual>1</ShippingCostActual>
  <Signature>sample string 5</Signature>
  <SignatureFileType>sample string 6</SignatureFileType>
  <Status>ReadyforDelivery</Status>
  <UpdateTime>2024-10-01T02:36:09.5709942-12:00</UpdateTime>
</OrderDeliveryStatus>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.