GET api/WebApiOdata/GetSupplierOrders?providerID={providerID}&searchString={searchString}&shopperID={shopperID}&statusID={statusID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| providerID | integer |
Required |
|
| searchString | string |
None. |
|
| shopperID | integer |
Default value is 0 |
|
| statusID | integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
Collection of OrderGridViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderActions | Collection of OrderActions |
None. |
|
| OrderID | integer |
None. |
|
| OrderNumber | integer |
None. |
|
| ShopperID | integer |
None. |
|
| EmailID | string |
None. |
|
| CompanyName | string |
None. |
|
| CompanyNameDisplay | string |
None. |
|
| ShopperName | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| PhoneNumber | string |
None. |
|
| OrderDate | date |
None. |
|
| OrderStatusID | byte |
None. |
|
| OrderTotal | decimal number |
None. |
|
| ConversionRate | decimal number |
None. |
|
| CurrentCurrency | string |
None. |
|
| CurrentCurrencySymbol | string |
None. |
|
| OrderStatus | string |
None. |
|
| OrderType | string |
None. |
|
| OrderTypeID | byte |
None. |
|
| PaymentMethodID | integer |
None. |
|
| CarrierID | integer |
None. |
|
| PONumber | string |
None. |
|
| RetailerName | string |
None. |
|
| StoreURL | string |
None. |
|
| UpdatedDate | date |
None. |
|
| ShowUndeliveredRejected | boolean |
None. |
|
| TotalAmountDisplay | string |
None. |
|
| OrderNumberDisplay | string |
None. |
|
| PONumberDisplay | string |
None. |
|
| Message | string |
None. |
|
| MessageID | integer |
None. |
|
| ShopperTypeID | integer |
None. |
|
| IsInvoiceAppInstalled | boolean |
None. |
|
| TimeZoneID | string |
None. |
|
| OrderDateDisplay | string |
None. |
|
| IsForApproval | boolean |
None. |
|
| OrderAttachments | string |
None. |
|
| ManagerID | integer |
None. |
|
| OrderPostStatus | string |
None. |
|
| StoreName | string |
None. |
|
| GroupID | integer |
None. |
|
| PGName | string |
None. |
|
| ShippingAddressID | integer |
None. |
|
| EstimateddDeliveryDate | string |
None. |
|
| ConnectorEntityID | string |
None. |
|
| OriginalConversionRate | decimal number |
None. |
|
| BaseTotalAmountDisplay | string |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
text/html
Sample:
Sample not available.
application/xml, text/xml
Sample:
<ArrayOfOrderGridViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SellersCommerce.ViewModels.Orders">
<OrderGridViewModel>
<CarrierID>14</CarrierID>
<CompanyName>sample string 3</CompanyName>
<ConnectorEntityID>sample string 33</ConnectorEntityID>
<ConversionRate>1.1</ConversionRate>
<CurrentCurrency>sample string 10</CurrentCurrency>
<EmailID>sample string 2</EmailID>
<EstimateddDeliveryDate>sample string 32</EstimateddDeliveryDate>
<FirstName>sample string 5</FirstName>
<GroupID>30</GroupID>
<IsForApproval>true</IsForApproval>
<IsInvoiceAppInstalled>true</IsInvoiceAppInstalled>
<LastName>sample string 6</LastName>
<ManagerID>27</ManagerID>
<Message>sample string 20</Message>
<MessageID>21</MessageID>
<OrderActions xmlns:d3p1="http://schemas.datacontract.org/2004/07/SellersCommerce.Entities.SCConstants" />
<OrderAttachments>sample string 26</OrderAttachments>
<OrderDate>2025-10-30T04:49:42.5980757+00:00</OrderDate>
<OrderID>1</OrderID>
<OrderNumber>1</OrderNumber>
<OrderPostStatus>sample string 28</OrderPostStatus>
<OrderStatus>sample string 11</OrderStatus>
<OrderStatusID>64</OrderStatusID>
<OrderTotal>1.1</OrderTotal>
<OrderType>sample string 12</OrderType>
<OrderTypeID>64</OrderTypeID>
<OriginalConversionRate>1.1</OriginalConversionRate>
<PGName>sample string 31</PGName>
<PONumber>sample string 15</PONumber>
<PaymentMethodID>13</PaymentMethodID>
<PhoneNumber>sample string 7</PhoneNumber>
<RetailerName>sample string 16</RetailerName>
<ShippingAddressID>1</ShippingAddressID>
<ShopperID>1</ShopperID>
<ShopperName>sample string 4</ShopperName>
<ShopperTypeID>22</ShopperTypeID>
<ShowUndeliveredRejected>true</ShowUndeliveredRejected>
<StoreName>sample string 29</StoreName>
<StoreURL>sample string 17</StoreURL>
<TimeZoneID>sample string 24</TimeZoneID>
<UpdatedDate>2025-10-30T04:49:42.5980757+00:00</UpdatedDate>
</OrderGridViewModel>
<OrderGridViewModel>
<CarrierID>14</CarrierID>
<CompanyName>sample string 3</CompanyName>
<ConnectorEntityID>sample string 33</ConnectorEntityID>
<ConversionRate>1.1</ConversionRate>
<CurrentCurrency>sample string 10</CurrentCurrency>
<EmailID>sample string 2</EmailID>
<EstimateddDeliveryDate>sample string 32</EstimateddDeliveryDate>
<FirstName>sample string 5</FirstName>
<GroupID>30</GroupID>
<IsForApproval>true</IsForApproval>
<IsInvoiceAppInstalled>true</IsInvoiceAppInstalled>
<LastName>sample string 6</LastName>
<ManagerID>27</ManagerID>
<Message>sample string 20</Message>
<MessageID>21</MessageID>
<OrderActions xmlns:d3p1="http://schemas.datacontract.org/2004/07/SellersCommerce.Entities.SCConstants" />
<OrderAttachments>sample string 26</OrderAttachments>
<OrderDate>2025-10-30T04:49:42.5980757+00:00</OrderDate>
<OrderID>1</OrderID>
<OrderNumber>1</OrderNumber>
<OrderPostStatus>sample string 28</OrderPostStatus>
<OrderStatus>sample string 11</OrderStatus>
<OrderStatusID>64</OrderStatusID>
<OrderTotal>1.1</OrderTotal>
<OrderType>sample string 12</OrderType>
<OrderTypeID>64</OrderTypeID>
<OriginalConversionRate>1.1</OriginalConversionRate>
<PGName>sample string 31</PGName>
<PONumber>sample string 15</PONumber>
<PaymentMethodID>13</PaymentMethodID>
<PhoneNumber>sample string 7</PhoneNumber>
<RetailerName>sample string 16</RetailerName>
<ShippingAddressID>1</ShippingAddressID>
<ShopperID>1</ShopperID>
<ShopperName>sample string 4</ShopperName>
<ShopperTypeID>22</ShopperTypeID>
<ShowUndeliveredRejected>true</ShowUndeliveredRejected>
<StoreName>sample string 29</StoreName>
<StoreURL>sample string 17</StoreURL>
<TimeZoneID>sample string 24</TimeZoneID>
<UpdatedDate>2025-10-30T04:49:42.5980757+00:00</UpdatedDate>
</OrderGridViewModel>
</ArrayOfOrderGridViewModel>