POST {opco}/api/v1/Route/{shipvia}

Request Information

URI Parameters

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

Body Parameters

ShippingRoute

Name	Type	Additional information
ShipDate	date	None.
ShippingBranch	string	None.
Driver	string	None.
Truck	string	None.
Orders	Collection of ShippingStop	None.

Request Formats

application/json, text/json

Sample:

{
  "shipDate": "2025-04-03T00:43:31.3373997-12:00",
  "shippingBranch": "sample string 2",
  "driver": "sample string 3",
  "truck": "sample string 4",
  "orders": [
    {
      "stopNumber": 1,
      "orderId": "sample string 2",
      "dropOffTime": "2025-04-03T00:43:31.3373997-12:00"
    },
    {
      "stopNumber": 1,
      "orderId": "sample string 2",
      "dropOffTime": "2025-04-03T00:43:31.3373997-12:00"
    }
  ]
}

application/xml, text/xml

Sample:

<ShippingRoute xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.Route.v1">
  <Driver>sample string 3</Driver>
  <Orders>
    <ShippingStop>
      <DropOffTime>2025-04-03T00:43:31.3373997-12:00</DropOffTime>
      <OrderId>sample string 2</OrderId>
      <StopNumber>1</StopNumber>
    </ShippingStop>
    <ShippingStop>
      <DropOffTime>2025-04-03T00:43:31.3373997-12:00</DropOffTime>
      <OrderId>sample string 2</OrderId>
      <StopNumber>1</StopNumber>
    </ShippingStop>
  </Orders>
  <ShipDate>2025-04-03T00:43:31.3373997-12:00</ShipDate>
  <ShippingBranch>sample string 2</ShippingBranch>
  <Truck>sample string 4</Truck>
</ShippingRoute>

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

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>