GET api/v1/CollectionRequest/COL_CR_GET_MerchantCollectionRequests
Returns current collection requests in REQUESTED, DESPATCHED and PENDING state
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
CollectionRequestSupplierModel| Name | Description | Type | Additional information |
|---|---|---|---|
| totalemptyrocsrequired | integer |
None. |
|
| collectionrequests | Collection of CollectionRequestGetModel |
None. |
|
| roccollectionrequestids | Collection of integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"collectionrequests": [
{
"ucocollectionrequestid": 1,
"entitytypename": "sample string 1",
"collectiontype": "sample string 2",
"deliverystatus": "sample string 3",
"datetimeofrequest": "2026-08-16T17:16:42.366902+00:00",
"datetimesuggested": "2026-08-16T17:16:42.366902+00:00",
"storeid": "2b256b39-91f4-477d-a797-d1b7b365e8a8",
"storename": "sample string 4",
"supplierid": "6e61654d-ebf6-4496-a5b2-cc013ac10b05",
"suppliername": "sample string 5",
"supplierlocationid": 1,
"supplierlocationname": "sample string 6",
"customerid": "4d97ea0c-0208-4cb6-916a-d4dd2b6a99ec",
"customername": "sample string 7",
"customerlocationid": 1,
"customerlocationname": "sample string 8",
"purchaseordernumber": "sample string 9",
"estimateducolitres": 1.0,
"numemptyrocsrequired": 10,
"numfullrocsforcollection": 11,
"latitude": 1.0,
"longitude": 1.0,
"comments": "sample string 12",
"containers": [
{
"quantity": 1.0,
"containertypeid": 2,
"state": "sample string 3",
"containernumber": "sample string 4"
},
{
"quantity": 1.0,
"containertypeid": 2,
"state": "sample string 3",
"containernumber": "sample string 4"
}
]
},
{
"ucocollectionrequestid": 1,
"entitytypename": "sample string 1",
"collectiontype": "sample string 2",
"deliverystatus": "sample string 3",
"datetimeofrequest": "2026-08-16T17:16:42.366902+00:00",
"datetimesuggested": "2026-08-16T17:16:42.366902+00:00",
"storeid": "2b256b39-91f4-477d-a797-d1b7b365e8a8",
"storename": "sample string 4",
"supplierid": "6e61654d-ebf6-4496-a5b2-cc013ac10b05",
"suppliername": "sample string 5",
"supplierlocationid": 1,
"supplierlocationname": "sample string 6",
"customerid": "4d97ea0c-0208-4cb6-916a-d4dd2b6a99ec",
"customername": "sample string 7",
"customerlocationid": 1,
"customerlocationname": "sample string 8",
"purchaseordernumber": "sample string 9",
"estimateducolitres": 1.0,
"numemptyrocsrequired": 10,
"numfullrocsforcollection": 11,
"latitude": 1.0,
"longitude": 1.0,
"comments": "sample string 12",
"containers": [
{
"quantity": 1.0,
"containertypeid": 2,
"state": "sample string 3",
"containernumber": "sample string 4"
},
{
"quantity": 1.0,
"containertypeid": 2,
"state": "sample string 3",
"containernumber": "sample string 4"
}
]
}
],
"roccollectionrequestids": [
1,
1
],
"totalemptyrocsrequired": 1
}
application/xml, text/xml
Sample:
<CollectionRequestSupplierModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.CollectionRequest">
<collectionrequests>
<CollectionRequestGetModel>
<collectiontype>sample string 2</collectiontype>
<comments>sample string 12</comments>
<containers xmlns:d4p1="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Containers">
<d4p1:UCOContainer>
<d4p1:containernumber>sample string 4</d4p1:containernumber>
<d4p1:state>sample string 3</d4p1:state>
<d4p1:containertypeid>2</d4p1:containertypeid>
<d4p1:quantity>1</d4p1:quantity>
</d4p1:UCOContainer>
<d4p1:UCOContainer>
<d4p1:containernumber>sample string 4</d4p1:containernumber>
<d4p1:state>sample string 3</d4p1:state>
<d4p1:containertypeid>2</d4p1:containertypeid>
<d4p1:quantity>1</d4p1:quantity>
</d4p1:UCOContainer>
</containers>
<customerid>4d97ea0c-0208-4cb6-916a-d4dd2b6a99ec</customerid>
<customerlocationid>1</customerlocationid>
<customerlocationname>sample string 8</customerlocationname>
<customername>sample string 7</customername>
<datetimeofrequest>2026-08-16T17:16:42.366902+00:00</datetimeofrequest>
<datetimesuggested>2026-08-16T17:16:42.366902+00:00</datetimesuggested>
<deliverystatus>sample string 3</deliverystatus>
<entitytypename>sample string 1</entitytypename>
<estimateducolitres>1</estimateducolitres>
<latitude>1</latitude>
<longitude>1</longitude>
<numemptyrocsrequired>10</numemptyrocsrequired>
<numfullrocsforcollection>11</numfullrocsforcollection>
<purchaseordernumber>sample string 9</purchaseordernumber>
<storeid>2b256b39-91f4-477d-a797-d1b7b365e8a8</storeid>
<storename>sample string 4</storename>
<supplierid>6e61654d-ebf6-4496-a5b2-cc013ac10b05</supplierid>
<supplierlocationid>1</supplierlocationid>
<supplierlocationname>sample string 6</supplierlocationname>
<suppliername>sample string 5</suppliername>
<ucocollectionrequestid>1</ucocollectionrequestid>
</CollectionRequestGetModel>
<CollectionRequestGetModel>
<collectiontype>sample string 2</collectiontype>
<comments>sample string 12</comments>
<containers xmlns:d4p1="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Containers">
<d4p1:UCOContainer>
<d4p1:containernumber>sample string 4</d4p1:containernumber>
<d4p1:state>sample string 3</d4p1:state>
<d4p1:containertypeid>2</d4p1:containertypeid>
<d4p1:quantity>1</d4p1:quantity>
</d4p1:UCOContainer>
<d4p1:UCOContainer>
<d4p1:containernumber>sample string 4</d4p1:containernumber>
<d4p1:state>sample string 3</d4p1:state>
<d4p1:containertypeid>2</d4p1:containertypeid>
<d4p1:quantity>1</d4p1:quantity>
</d4p1:UCOContainer>
</containers>
<customerid>4d97ea0c-0208-4cb6-916a-d4dd2b6a99ec</customerid>
<customerlocationid>1</customerlocationid>
<customerlocationname>sample string 8</customerlocationname>
<customername>sample string 7</customername>
<datetimeofrequest>2026-08-16T17:16:42.366902+00:00</datetimeofrequest>
<datetimesuggested>2026-08-16T17:16:42.366902+00:00</datetimesuggested>
<deliverystatus>sample string 3</deliverystatus>
<entitytypename>sample string 1</entitytypename>
<estimateducolitres>1</estimateducolitres>
<latitude>1</latitude>
<longitude>1</longitude>
<numemptyrocsrequired>10</numemptyrocsrequired>
<numfullrocsforcollection>11</numfullrocsforcollection>
<purchaseordernumber>sample string 9</purchaseordernumber>
<storeid>2b256b39-91f4-477d-a797-d1b7b365e8a8</storeid>
<storename>sample string 4</storename>
<supplierid>6e61654d-ebf6-4496-a5b2-cc013ac10b05</supplierid>
<supplierlocationid>1</supplierlocationid>
<supplierlocationname>sample string 6</supplierlocationname>
<suppliername>sample string 5</suppliername>
<ucocollectionrequestid>1</ucocollectionrequestid>
</CollectionRequestGetModel>
</collectionrequests>
<roccollectionrequestids xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:int>1</d2p1:int>
<d2p1:int>1</d2p1:int>
</roccollectionrequestids>
<totalemptyrocsrequired>1</totalemptyrocsrequired>
</CollectionRequestSupplierModel>