POST api/bulkdispatch/getBulkDispatchExcel

Request Information

URI Parameters

None.

Body Parameters

BulkDispatchCriteria
NameDescriptionTypeAdditional information
LOCNCODE

string

None.

SLPRSNID

string

None.

CUSTNMBR

string

None.

Driver

string

None.

AllTrailers

boolean

None.

InYard

boolean

None.

PickupAvailable

boolean

None.

BeingServiced

boolean

None.

AtCustomer

boolean

None.

CurrentView

boolean

None.

HistoricalView

boolean

None.

IncludeInactive

boolean

None.

EmpId

integer

None.

gettinglocations

boolean

None.

gettingreps

boolean

None.

gettingcustomers

boolean

None.

gettingdrivers

boolean

None.

history_rec

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "LOCNCODE": "sample string 1",
  "SLPRSNID": "sample string 2",
  "CUSTNMBR": "sample string 3",
  "Driver": "sample string 4",
  "AllTrailers": true,
  "InYard": true,
  "PickupAvailable": true,
  "BeingServiced": true,
  "AtCustomer": true,
  "CurrentView": true,
  "HistoricalView": true,
  "IncludeInactive": true,
  "EmpId": 13,
  "gettinglocations": true,
  "gettingreps": true,
  "gettingcustomers": true,
  "gettingdrivers": true,
  "history_rec": 18
}

application/xml, text/xml

Sample:
<BulkDispatchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OperationsManagerAPI.Models">
  <AllTrailers>true</AllTrailers>
  <AtCustomer>true</AtCustomer>
  <BeingServiced>true</BeingServiced>
  <CUSTNMBR>sample string 3</CUSTNMBR>
  <CurrentView>true</CurrentView>
  <Driver>sample string 4</Driver>
  <EmpId>13</EmpId>
  <HistoricalView>true</HistoricalView>
  <InYard>true</InYard>
  <IncludeInactive>true</IncludeInactive>
  <LOCNCODE>sample string 1</LOCNCODE>
  <PickupAvailable>true</PickupAvailable>
  <SLPRSNID>sample string 2</SLPRSNID>
  <gettingcustomers>true</gettingcustomers>
  <gettingdrivers>true</gettingdrivers>
  <gettinglocations>true</gettinglocations>
  <gettingreps>true</gettingreps>
  <history_rec>18</history_rec>
</BulkDispatchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of BulkDispatch
NameDescriptionTypeAdditional information
history_rec

integer

None.

history_detail_rec

integer

None.

LOCNCODE

string

None.

truck_num

string

None.

CUSTNMBR

string

None.

CUSTNAME

string

None.

salesman

string

None.

salesman_name

string

None.

SalesmanLastName

string

None.

ship_to

string

None.

ship_to_city

string

None.

ship_to_phone

string

None.

special_instructions

string

None.

avail_date

date

None.

return_date

date

None.

pickup_driver

string

None.

ship_date

date

None.

driver

string

None.

ship_to_addr

string

None.

ship_to_addr2

string

None.

ship_to_state

string

None.

ship_to_zip

string

None.

BulkContact

string

None.

BulkPhone

string

None.

BulkPickUp

date

None.

service_company

string

None.

NumDays

integer

None.

TrailerStatus

string

None.

batch_num

string

None.

qty

decimal number

None.

analysis

string

None.

comments

string

None.

batch

BulkDispatchDetails

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "history_rec": 1,
    "history_detail_rec": 2,
    "LOCNCODE": "sample string 3",
    "truck_num": "sample string 4",
    "CUSTNMBR": "sample string 5",
    "CUSTNAME": "sample string 6",
    "salesman": "sample string 7",
    "salesman_name": "sample string 8",
    "SalesmanLastName": "sample string 9",
    "ship_to": "sample string 10",
    "ship_to_city": "sample string 11",
    "ship_to_phone": "sample string 12",
    "special_instructions": "sample string 13",
    "avail_date": "2026-11-21T06:00:43.5273392+00:00",
    "return_date": "2026-11-21T06:00:43.5273392+00:00",
    "pickup_driver": "sample string 14",
    "ship_date": "2026-11-21T06:00:43.5273392+00:00",
    "driver": "sample string 15",
    "ship_to_addr": "sample string 16",
    "ship_to_addr2": "sample string 17",
    "ship_to_state": "sample string 18",
    "ship_to_zip": "sample string 19",
    "BulkContact": "sample string 20",
    "BulkPhone": "sample string 21",
    "BulkPickUp": "2026-11-21T06:00:43.5273392+00:00",
    "service_company": "sample string 22",
    "NumDays": 23,
    "TrailerStatus": "sample string 24",
    "batch_num": "sample string 25",
    "qty": 26.1,
    "analysis": "sample string 27",
    "comments": "sample string 28",
    "batch": {
      "history_detail_rec": 1,
      "history_rec": 2,
      "batch_num": "sample string 3",
      "qty": 4.1,
      "analysis": "sample string 5",
      "comments": "sample string 6"
    }
  },
  {
    "history_rec": 1,
    "history_detail_rec": 2,
    "LOCNCODE": "sample string 3",
    "truck_num": "sample string 4",
    "CUSTNMBR": "sample string 5",
    "CUSTNAME": "sample string 6",
    "salesman": "sample string 7",
    "salesman_name": "sample string 8",
    "SalesmanLastName": "sample string 9",
    "ship_to": "sample string 10",
    "ship_to_city": "sample string 11",
    "ship_to_phone": "sample string 12",
    "special_instructions": "sample string 13",
    "avail_date": "2026-11-21T06:00:43.5273392+00:00",
    "return_date": "2026-11-21T06:00:43.5273392+00:00",
    "pickup_driver": "sample string 14",
    "ship_date": "2026-11-21T06:00:43.5273392+00:00",
    "driver": "sample string 15",
    "ship_to_addr": "sample string 16",
    "ship_to_addr2": "sample string 17",
    "ship_to_state": "sample string 18",
    "ship_to_zip": "sample string 19",
    "BulkContact": "sample string 20",
    "BulkPhone": "sample string 21",
    "BulkPickUp": "2026-11-21T06:00:43.5273392+00:00",
    "service_company": "sample string 22",
    "NumDays": 23,
    "TrailerStatus": "sample string 24",
    "batch_num": "sample string 25",
    "qty": 26.1,
    "analysis": "sample string 27",
    "comments": "sample string 28",
    "batch": {
      "history_detail_rec": 1,
      "history_rec": 2,
      "batch_num": "sample string 3",
      "qty": 4.1,
      "analysis": "sample string 5",
      "comments": "sample string 6"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfBulkDispatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OperationsManagerAPI.Models">
  <BulkDispatch>
    <BulkContact>sample string 20</BulkContact>
    <BulkPhone>sample string 21</BulkPhone>
    <BulkPickUp>2026-11-21T06:00:43.5273392+00:00</BulkPickUp>
    <CUSTNAME>sample string 6</CUSTNAME>
    <CUSTNMBR>sample string 5</CUSTNMBR>
    <LOCNCODE>sample string 3</LOCNCODE>
    <NumDays>23</NumDays>
    <SalesmanLastName>sample string 9</SalesmanLastName>
    <TrailerStatus>sample string 24</TrailerStatus>
    <analysis>sample string 27</analysis>
    <avail_date>2026-11-21T06:00:43.5273392+00:00</avail_date>
    <batch>
      <analysis>sample string 5</analysis>
      <batch_num>sample string 3</batch_num>
      <comments>sample string 6</comments>
      <history_detail_rec>1</history_detail_rec>
      <history_rec>2</history_rec>
      <qty>4.1</qty>
    </batch>
    <batch_num>sample string 25</batch_num>
    <comments>sample string 28</comments>
    <driver>sample string 15</driver>
    <history_detail_rec>2</history_detail_rec>
    <history_rec>1</history_rec>
    <pickup_driver>sample string 14</pickup_driver>
    <qty>26.1</qty>
    <return_date>2026-11-21T06:00:43.5273392+00:00</return_date>
    <salesman>sample string 7</salesman>
    <salesman_name>sample string 8</salesman_name>
    <service_company>sample string 22</service_company>
    <ship_date>2026-11-21T06:00:43.5273392+00:00</ship_date>
    <ship_to>sample string 10</ship_to>
    <ship_to_addr>sample string 16</ship_to_addr>
    <ship_to_addr2>sample string 17</ship_to_addr2>
    <ship_to_city>sample string 11</ship_to_city>
    <ship_to_phone>sample string 12</ship_to_phone>
    <ship_to_state>sample string 18</ship_to_state>
    <ship_to_zip>sample string 19</ship_to_zip>
    <special_instructions>sample string 13</special_instructions>
    <truck_num>sample string 4</truck_num>
  </BulkDispatch>
  <BulkDispatch>
    <BulkContact>sample string 20</BulkContact>
    <BulkPhone>sample string 21</BulkPhone>
    <BulkPickUp>2026-11-21T06:00:43.5273392+00:00</BulkPickUp>
    <CUSTNAME>sample string 6</CUSTNAME>
    <CUSTNMBR>sample string 5</CUSTNMBR>
    <LOCNCODE>sample string 3</LOCNCODE>
    <NumDays>23</NumDays>
    <SalesmanLastName>sample string 9</SalesmanLastName>
    <TrailerStatus>sample string 24</TrailerStatus>
    <analysis>sample string 27</analysis>
    <avail_date>2026-11-21T06:00:43.5273392+00:00</avail_date>
    <batch>
      <analysis>sample string 5</analysis>
      <batch_num>sample string 3</batch_num>
      <comments>sample string 6</comments>
      <history_detail_rec>1</history_detail_rec>
      <history_rec>2</history_rec>
      <qty>4.1</qty>
    </batch>
    <batch_num>sample string 25</batch_num>
    <comments>sample string 28</comments>
    <driver>sample string 15</driver>
    <history_detail_rec>2</history_detail_rec>
    <history_rec>1</history_rec>
    <pickup_driver>sample string 14</pickup_driver>
    <qty>26.1</qty>
    <return_date>2026-11-21T06:00:43.5273392+00:00</return_date>
    <salesman>sample string 7</salesman>
    <salesman_name>sample string 8</salesman_name>
    <service_company>sample string 22</service_company>
    <ship_date>2026-11-21T06:00:43.5273392+00:00</ship_date>
    <ship_to>sample string 10</ship_to>
    <ship_to_addr>sample string 16</ship_to_addr>
    <ship_to_addr2>sample string 17</ship_to_addr2>
    <ship_to_city>sample string 11</ship_to_city>
    <ship_to_phone>sample string 12</ship_to_phone>
    <ship_to_state>sample string 18</ship_to_state>
    <ship_to_zip>sample string 19</ship_to_zip>
    <special_instructions>sample string 13</special_instructions>
    <truck_num>sample string 4</truck_num>
  </BulkDispatch>
</ArrayOfBulkDispatch>