POST api/Parcel/FindCarrierJobs?authToken={authToken}
Find Carrier Jobs
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| authToken |
The Authentication Token |
string |
Required |
Body Parameters
The Filters
PagedRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Page | integer |
None. |
|
| PageSize | integer |
None. |
|
| SortField | string |
None. |
|
| SortOrder | string |
None. |
|
| Filters | Collection of FilterModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"Page": 1,
"PageSize": 2,
"SortField": "sample string 3",
"SortOrder": "sample string 4",
"Filters": [
{
"Id": "sample string 1",
"Name": "sample string 2",
"Value": "sample string 3",
"Operator": 1,
"RelatedField": "sample string 4",
"RadioId": "sample string 5",
"RenderValue": "sample string 6"
},
{
"Id": "sample string 1",
"Name": "sample string 2",
"Value": "sample string 3",
"Operator": 1,
"RelatedField": "sample string 4",
"RadioId": "sample string 5",
"RenderValue": "sample string 6"
}
]
}
application/xml, text/xml
Sample:
<PagedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.Filters">
<FilterCondition>And</FilterCondition>
<Filters>
<FilterModel>
<Id>sample string 1</Id>
<Name>sample string 2</Name>
<Operator>Equal</Operator>
<RadioId>sample string 5</RadioId>
<RelatedField>sample string 4</RelatedField>
<RenderValue>sample string 6</RenderValue>
<Value>sample string 3</Value>
</FilterModel>
<FilterModel>
<Id>sample string 1</Id>
<Name>sample string 2</Name>
<Operator>Equal</Operator>
<RadioId>sample string 5</RadioId>
<RelatedField>sample string 4</RelatedField>
<RenderValue>sample string 6</RenderValue>
<Value>sample string 3</Value>
</FilterModel>
</Filters>
<Page>1</Page>
<PageSize>2</PageSize>
<SortField>sample string 3</SortField>
<SortOrder>sample string 4</SortOrder>
</PagedRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceResultOfPagedModelOfCarrierParcelsListItemModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | PagedModelOfCarrierParcelsListItemModel |
None. |
|
| ErrorCode | ServiceErrorCode |
None. |
|
| ErrorMessage | Collection of string |
None. |
|
| Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Result": {
"Page": 1,
"PageIndex": 1,
"PageSize": 2,
"Rows": [
{
"Name": "sample string 1",
"Rating": 2.0,
"AuctionParcelId": "6f89f590-29d5-4f6c-9fe8-131a62cdbf05",
"ParcelId": "7bfabfdc-ff40-4f6f-9950-a037a32e1875",
"DeliveryState": 5,
"DeliveryStateId": 6,
"MinZipCode": "sample string 7",
"AuctionStateId": 8,
"MaxZipCode": "sample string 9",
"WinnerUserId": "75259a1d-5841-4bdc-85d8-9e1da37edb78",
"WinnerEntityId": "af99ff68-d1ed-47b8-88dc-e76f46086abd",
"AuctionEntityId": "08bb38ba-50db-4f62-9116-d94342820589",
"AuctionDeliveryDateDisplay": "sample string 13",
"AuctionDeliveryDate": "2025-10-24T10:16:30.0724651+00:00",
"AuctionPickUpDateDisplay": "sample string 14",
"AuctionPickUpDate": "2025-10-24T10:16:30.0724651+00:00",
"AuctionExpirationDate": "2025-10-24T10:16:30.0724651+00:00",
"AuctionCreatedDate": "2025-10-24T10:16:30.0724651+00:00",
"AverageVolumeDisplay": "sample string 17",
"AverageVolume": 18.0,
"TotalWeightDisplay": "sample string 19",
"TotalWeight": 20.0,
"TotalVolumes": 21,
"BidParcelId": "sample string 22",
"AuctionId": "fc1dc807-ba9c-4388-82ac-b69259f3a325",
"DestinationZipCode": "sample string 24",
"CollectionZipCode": "sample string 25",
"DestinationCity": "sample string 26",
"CollectionCity": "sample string 27"
},
{
"Name": "sample string 1",
"Rating": 2.0,
"AuctionParcelId": "6f89f590-29d5-4f6c-9fe8-131a62cdbf05",
"ParcelId": "7bfabfdc-ff40-4f6f-9950-a037a32e1875",
"DeliveryState": 5,
"DeliveryStateId": 6,
"MinZipCode": "sample string 7",
"AuctionStateId": 8,
"MaxZipCode": "sample string 9",
"WinnerUserId": "75259a1d-5841-4bdc-85d8-9e1da37edb78",
"WinnerEntityId": "af99ff68-d1ed-47b8-88dc-e76f46086abd",
"AuctionEntityId": "08bb38ba-50db-4f62-9116-d94342820589",
"AuctionDeliveryDateDisplay": "sample string 13",
"AuctionDeliveryDate": "2025-10-24T10:16:30.0724651+00:00",
"AuctionPickUpDateDisplay": "sample string 14",
"AuctionPickUpDate": "2025-10-24T10:16:30.0724651+00:00",
"AuctionExpirationDate": "2025-10-24T10:16:30.0724651+00:00",
"AuctionCreatedDate": "2025-10-24T10:16:30.0724651+00:00",
"AverageVolumeDisplay": "sample string 17",
"AverageVolume": 18.0,
"TotalWeightDisplay": "sample string 19",
"TotalWeight": 20.0,
"TotalVolumes": 21,
"BidParcelId": "sample string 22",
"AuctionId": "fc1dc807-ba9c-4388-82ac-b69259f3a325",
"DestinationZipCode": "sample string 24",
"CollectionZipCode": "sample string 25",
"DestinationCity": "sample string 26",
"CollectionCity": "sample string 27"
}
],
"Footer": {
"Name": "sample string 1",
"Rating": 2.0,
"AuctionParcelId": "6f89f590-29d5-4f6c-9fe8-131a62cdbf05",
"ParcelId": "7bfabfdc-ff40-4f6f-9950-a037a32e1875",
"DeliveryState": 5,
"DeliveryStateId": 6,
"MinZipCode": "sample string 7",
"AuctionStateId": 8,
"MaxZipCode": "sample string 9",
"WinnerUserId": "75259a1d-5841-4bdc-85d8-9e1da37edb78",
"WinnerEntityId": "af99ff68-d1ed-47b8-88dc-e76f46086abd",
"AuctionEntityId": "08bb38ba-50db-4f62-9116-d94342820589",
"AuctionDeliveryDateDisplay": "sample string 13",
"AuctionDeliveryDate": "2025-10-24T10:16:30.0724651+00:00",
"AuctionPickUpDateDisplay": "sample string 14",
"AuctionPickUpDate": "2025-10-24T10:16:30.0724651+00:00",
"AuctionExpirationDate": "2025-10-24T10:16:30.0724651+00:00",
"AuctionCreatedDate": "2025-10-24T10:16:30.0724651+00:00",
"AverageVolumeDisplay": "sample string 17",
"AverageVolume": 18.0,
"TotalWeightDisplay": "sample string 19",
"TotalWeight": 20.0,
"TotalVolumes": 21,
"BidParcelId": "sample string 22",
"AuctionId": "fc1dc807-ba9c-4388-82ac-b69259f3a325",
"DestinationZipCode": "sample string 24",
"CollectionZipCode": "sample string 25",
"DestinationCity": "sample string 26",
"CollectionCity": "sample string 27"
},
"TotalPages": 3,
"TotalRows": 4
},
"ErrorCode": 0,
"ErrorMessage": [
"sample string 1",
"sample string 2"
],
"Success": true
}
application/xml, text/xml
Sample:
<ServiceResultOfPagedModelOfCarrierParcelsListItemModelEJHQiVccHLrnX27W xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.ApiObjects.Results">
<ErrorCode>None</ErrorCode>
<ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ErrorMessage>
<Success>true</Success>
<Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.Filters">
<d2p1:Footer xmlns:d3p1="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models">
<d3p1:AuctionCreatedDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionCreatedDate>
<d3p1:AuctionDeliveryDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionDeliveryDate>
<d3p1:AuctionDeliveryDateDisplay>sample string 13</d3p1:AuctionDeliveryDateDisplay>
<d3p1:AuctionEntityId>08bb38ba-50db-4f62-9116-d94342820589</d3p1:AuctionEntityId>
<d3p1:AuctionExpirationDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionExpirationDate>
<d3p1:AuctionId>fc1dc807-ba9c-4388-82ac-b69259f3a325</d3p1:AuctionId>
<d3p1:AuctionParcelId>6f89f590-29d5-4f6c-9fe8-131a62cdbf05</d3p1:AuctionParcelId>
<d3p1:AuctionPickUpDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionPickUpDate>
<d3p1:AuctionPickUpDateDisplay>sample string 14</d3p1:AuctionPickUpDateDisplay>
<d3p1:AuctionStateId>8</d3p1:AuctionStateId>
<d3p1:AverageVolume>18</d3p1:AverageVolume>
<d3p1:AverageVolumeDisplay>sample string 17</d3p1:AverageVolumeDisplay>
<d3p1:BidParcelId>sample string 22</d3p1:BidParcelId>
<d3p1:CollectionCity>sample string 27</d3p1:CollectionCity>
<d3p1:CollectionZipCode>sample string 25</d3p1:CollectionZipCode>
<d3p1:DeliveryState>5</d3p1:DeliveryState>
<d3p1:DeliveryStateId>6</d3p1:DeliveryStateId>
<d3p1:DestinationCity>sample string 26</d3p1:DestinationCity>
<d3p1:DestinationZipCode>sample string 24</d3p1:DestinationZipCode>
<d3p1:MaxZipCode>sample string 9</d3p1:MaxZipCode>
<d3p1:MinZipCode>sample string 7</d3p1:MinZipCode>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:ParcelId>7bfabfdc-ff40-4f6f-9950-a037a32e1875</d3p1:ParcelId>
<d3p1:Rating>2</d3p1:Rating>
<d3p1:TotalVolumes>21</d3p1:TotalVolumes>
<d3p1:TotalWeight>20</d3p1:TotalWeight>
<d3p1:TotalWeightDisplay>sample string 19</d3p1:TotalWeightDisplay>
<d3p1:WinnerEntityId>af99ff68-d1ed-47b8-88dc-e76f46086abd</d3p1:WinnerEntityId>
<d3p1:WinnerUserId>75259a1d-5841-4bdc-85d8-9e1da37edb78</d3p1:WinnerUserId>
</d2p1:Footer>
<d2p1:PageIndex>1</d2p1:PageIndex>
<d2p1:PageSize>2</d2p1:PageSize>
<d2p1:Rows xmlns:d3p1="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models">
<d3p1:CarrierParcelsListItemModel>
<d3p1:AuctionCreatedDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionCreatedDate>
<d3p1:AuctionDeliveryDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionDeliveryDate>
<d3p1:AuctionDeliveryDateDisplay>sample string 13</d3p1:AuctionDeliveryDateDisplay>
<d3p1:AuctionEntityId>08bb38ba-50db-4f62-9116-d94342820589</d3p1:AuctionEntityId>
<d3p1:AuctionExpirationDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionExpirationDate>
<d3p1:AuctionId>fc1dc807-ba9c-4388-82ac-b69259f3a325</d3p1:AuctionId>
<d3p1:AuctionParcelId>6f89f590-29d5-4f6c-9fe8-131a62cdbf05</d3p1:AuctionParcelId>
<d3p1:AuctionPickUpDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionPickUpDate>
<d3p1:AuctionPickUpDateDisplay>sample string 14</d3p1:AuctionPickUpDateDisplay>
<d3p1:AuctionStateId>8</d3p1:AuctionStateId>
<d3p1:AverageVolume>18</d3p1:AverageVolume>
<d3p1:AverageVolumeDisplay>sample string 17</d3p1:AverageVolumeDisplay>
<d3p1:BidParcelId>sample string 22</d3p1:BidParcelId>
<d3p1:CollectionCity>sample string 27</d3p1:CollectionCity>
<d3p1:CollectionZipCode>sample string 25</d3p1:CollectionZipCode>
<d3p1:DeliveryState>5</d3p1:DeliveryState>
<d3p1:DeliveryStateId>6</d3p1:DeliveryStateId>
<d3p1:DestinationCity>sample string 26</d3p1:DestinationCity>
<d3p1:DestinationZipCode>sample string 24</d3p1:DestinationZipCode>
<d3p1:MaxZipCode>sample string 9</d3p1:MaxZipCode>
<d3p1:MinZipCode>sample string 7</d3p1:MinZipCode>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:ParcelId>7bfabfdc-ff40-4f6f-9950-a037a32e1875</d3p1:ParcelId>
<d3p1:Rating>2</d3p1:Rating>
<d3p1:TotalVolumes>21</d3p1:TotalVolumes>
<d3p1:TotalWeight>20</d3p1:TotalWeight>
<d3p1:TotalWeightDisplay>sample string 19</d3p1:TotalWeightDisplay>
<d3p1:WinnerEntityId>af99ff68-d1ed-47b8-88dc-e76f46086abd</d3p1:WinnerEntityId>
<d3p1:WinnerUserId>75259a1d-5841-4bdc-85d8-9e1da37edb78</d3p1:WinnerUserId>
</d3p1:CarrierParcelsListItemModel>
<d3p1:CarrierParcelsListItemModel>
<d3p1:AuctionCreatedDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionCreatedDate>
<d3p1:AuctionDeliveryDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionDeliveryDate>
<d3p1:AuctionDeliveryDateDisplay>sample string 13</d3p1:AuctionDeliveryDateDisplay>
<d3p1:AuctionEntityId>08bb38ba-50db-4f62-9116-d94342820589</d3p1:AuctionEntityId>
<d3p1:AuctionExpirationDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionExpirationDate>
<d3p1:AuctionId>fc1dc807-ba9c-4388-82ac-b69259f3a325</d3p1:AuctionId>
<d3p1:AuctionParcelId>6f89f590-29d5-4f6c-9fe8-131a62cdbf05</d3p1:AuctionParcelId>
<d3p1:AuctionPickUpDate>2025-10-24T10:16:30.0724651+00:00</d3p1:AuctionPickUpDate>
<d3p1:AuctionPickUpDateDisplay>sample string 14</d3p1:AuctionPickUpDateDisplay>
<d3p1:AuctionStateId>8</d3p1:AuctionStateId>
<d3p1:AverageVolume>18</d3p1:AverageVolume>
<d3p1:AverageVolumeDisplay>sample string 17</d3p1:AverageVolumeDisplay>
<d3p1:BidParcelId>sample string 22</d3p1:BidParcelId>
<d3p1:CollectionCity>sample string 27</d3p1:CollectionCity>
<d3p1:CollectionZipCode>sample string 25</d3p1:CollectionZipCode>
<d3p1:DeliveryState>5</d3p1:DeliveryState>
<d3p1:DeliveryStateId>6</d3p1:DeliveryStateId>
<d3p1:DestinationCity>sample string 26</d3p1:DestinationCity>
<d3p1:DestinationZipCode>sample string 24</d3p1:DestinationZipCode>
<d3p1:MaxZipCode>sample string 9</d3p1:MaxZipCode>
<d3p1:MinZipCode>sample string 7</d3p1:MinZipCode>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:ParcelId>7bfabfdc-ff40-4f6f-9950-a037a32e1875</d3p1:ParcelId>
<d3p1:Rating>2</d3p1:Rating>
<d3p1:TotalVolumes>21</d3p1:TotalVolumes>
<d3p1:TotalWeight>20</d3p1:TotalWeight>
<d3p1:TotalWeightDisplay>sample string 19</d3p1:TotalWeightDisplay>
<d3p1:WinnerEntityId>af99ff68-d1ed-47b8-88dc-e76f46086abd</d3p1:WinnerEntityId>
<d3p1:WinnerUserId>75259a1d-5841-4bdc-85d8-9e1da37edb78</d3p1:WinnerUserId>
</d3p1:CarrierParcelsListItemModel>
</d2p1:Rows>
<d2p1:TotalPages>3</d2p1:TotalPages>
<d2p1:TotalRows>4</d2p1:TotalRows>
</Result>
</ServiceResultOfPagedModelOfCarrierParcelsListItemModelEJHQiVccHLrnX27W>