POST api/CentralPicker/CreateVirtualLineHaul

Request Information

URI Parameters

None.

Body Parameters

CreateVirtualLineHaul
NameDescriptionTypeAdditional information
BusinessId

integer

None.

UserId

integer

None.

LocationId

integer

None.

PrimaryWaarehouseId

integer

None.

WarehouseBusinessId

integer

None.

Source

string

None.

ShipmentIds

string

None.

DetailsJson

string

None.

Request Formats

application/json, text/json

Sample:
{
  "BusinessId": 1,
  "UserId": 2,
  "LocationId": 3,
  "PrimaryWaarehouseId": 4,
  "WarehouseBusinessId": 5,
  "Source": "sample string 6",
  "ShipmentIds": "sample string 7",
  "DetailsJson": "sample string 8"
}

application/xml, text/xml

Sample:
<CreateVirtualLineHaul xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <BusinessId>1</BusinessId>
  <DetailsJson>sample string 8</DetailsJson>
  <LocationId>3</LocationId>
  <PrimaryWaarehouseId>4</PrimaryWaarehouseId>
  <ShipmentIds>sample string 7</ShipmentIds>
  <Source>sample string 6</Source>
  <UserId>2</UserId>
  <WarehouseBusinessId>5</WarehouseBusinessId>
</CreateVirtualLineHaul>

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

Response Information

Resource Description

VCAPIResponse
NameDescriptionTypeAdditional 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/19 18:18:28",
  "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>