GET api/WebApiOdata/GetProviderOrderGrids?providerID={providerID}&searchString={searchString}&shopperID={shopperID}&statusID={statusID}&managerID={managerID}&preferredGroupOrders={preferredGroupOrders}&forShippingLabel={forShippingLabel}&datapageSize={datapageSize}&filterDataPageSize={filterDataPageSize}

Request Information

URI Parameters

Name	Type	Additional information
providerID	integer	Required
searchString	string	None.
shopperID	integer	Default value is 0
statusID	integer	Default value is 0
managerID	integer	Default value is 0
preferredGroupOrders	boolean	Default value is False
forShippingLabel	boolean	Default value is False
datapageSize	integer	Default value is 0
filterDataPageSize	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of OrderGridViewModel

Name	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.
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.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "OrderActions": [],
    "OrderID": 1,
    "OrderNumber": 1,
    "ShopperID": 1,
    "EmailID": "sample string 2",
    "CompanyName": "sample string 3",
    "CompanyNameDisplay": "sample string 3",
    "ShopperName": "sample string 4",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "PhoneNumber": "sample string 7",
    "OrderDate": "9/19/2024",
    "OrderStatusID": 64,
    "OrderTotal": 1.1,
    "ConversionRate": 1.1,
    "CurrentCurrency": "sample string 10",
    "CurrentCurrencySymbol": "",
    "OrderStatus": "sample string 11",
    "OrderType": "sample string 12",
    "OrderTypeID": 64,
    "PaymentMethodID": 14,
    "CarrierID": 15,
    "PONumber": "sample string 16",
    "RetailerName": "sample string 17",
    "StoreURL": "sample string 18",
    "UpdatedDate": "9/19/2024",
    "ShowUndeliveredRejected": true,
    "TotalAmountDisplay": "1.21",
    "OrderNumberDisplay": "1",
    "PONumberDisplay": "sample string 16",
    "Message": "sample string 21",
    "MessageID": 22,
    "ShopperTypeID": 23,
    "IsInvoiceAppInstalled": true,
    "OrderDateDisplay": "9/19/2024 8:33:57 AM",
    "IsForApproval": true,
    "OrderAttachments": "sample string 26",
    "ManagerID": 27,
    "OrderPostStatus": "sample string 28",
    "StoreName": "sample string 29",
    "GroupID": 30,
    "PGName": "sample string 31",
    "ShippingAddressID": 1,
    "EstimateddDeliveryDate": "sample string 32"
  },
  {
    "OrderActions": [],
    "OrderID": 1,
    "OrderNumber": 1,
    "ShopperID": 1,
    "EmailID": "sample string 2",
    "CompanyName": "sample string 3",
    "CompanyNameDisplay": "sample string 3",
    "ShopperName": "sample string 4",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "PhoneNumber": "sample string 7",
    "OrderDate": "9/19/2024",
    "OrderStatusID": 64,
    "OrderTotal": 1.1,
    "ConversionRate": 1.1,
    "CurrentCurrency": "sample string 10",
    "CurrentCurrencySymbol": "",
    "OrderStatus": "sample string 11",
    "OrderType": "sample string 12",
    "OrderTypeID": 64,
    "PaymentMethodID": 14,
    "CarrierID": 15,
    "PONumber": "sample string 16",
    "RetailerName": "sample string 17",
    "StoreURL": "sample string 18",
    "UpdatedDate": "9/19/2024",
    "ShowUndeliveredRejected": true,
    "TotalAmountDisplay": "1.21",
    "OrderNumberDisplay": "1",
    "PONumberDisplay": "sample string 16",
    "Message": "sample string 21",
    "MessageID": 22,
    "ShopperTypeID": 23,
    "IsInvoiceAppInstalled": true,
    "OrderDateDisplay": "9/19/2024 8:33:57 AM",
    "IsForApproval": true,
    "OrderAttachments": "sample string 26",
    "ManagerID": 27,
    "OrderPostStatus": "sample string 28",
    "StoreName": "sample string 29",
    "GroupID": 30,
    "PGName": "sample string 31",
    "ShippingAddressID": 1,
    "EstimateddDeliveryDate": "sample string 32"
  }
]

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>15</CarrierID>
    <CompanyName>sample string 3</CompanyName>
    <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 21</Message>
    <MessageID>22</MessageID>
    <OrderActions xmlns:d3p1="http://schemas.datacontract.org/2004/07/SellersCommerce.Entities.SCConstants" />
    <OrderAttachments>sample string 26</OrderAttachments>
    <OrderDate>2024-09-19T08:33:57.8920697+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>
    <PGName>sample string 31</PGName>
    <PONumber>sample string 16</PONumber>
    <PaymentMethodID>14</PaymentMethodID>
    <PhoneNumber>sample string 7</PhoneNumber>
    <RetailerName>sample string 17</RetailerName>
    <ShippingAddressID>1</ShippingAddressID>
    <ShopperID>1</ShopperID>
    <ShopperName>sample string 4</ShopperName>
    <ShopperTypeID>23</ShopperTypeID>
    <ShowUndeliveredRejected>true</ShowUndeliveredRejected>
    <StoreName>sample string 29</StoreName>
    <StoreURL>sample string 18</StoreURL>
    <UpdatedDate>2024-09-19T08:33:57.8920697+00:00</UpdatedDate>
  </OrderGridViewModel>
  <OrderGridViewModel>
    <CarrierID>15</CarrierID>
    <CompanyName>sample string 3</CompanyName>
    <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 21</Message>
    <MessageID>22</MessageID>
    <OrderActions xmlns:d3p1="http://schemas.datacontract.org/2004/07/SellersCommerce.Entities.SCConstants" />
    <OrderAttachments>sample string 26</OrderAttachments>
    <OrderDate>2024-09-19T08:33:57.8920697+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>
    <PGName>sample string 31</PGName>
    <PONumber>sample string 16</PONumber>
    <PaymentMethodID>14</PaymentMethodID>
    <PhoneNumber>sample string 7</PhoneNumber>
    <RetailerName>sample string 17</RetailerName>
    <ShippingAddressID>1</ShippingAddressID>
    <ShopperID>1</ShopperID>
    <ShopperName>sample string 4</ShopperName>
    <ShopperTypeID>23</ShopperTypeID>
    <ShowUndeliveredRejected>true</ShowUndeliveredRejected>
    <StoreName>sample string 29</StoreName>
    <StoreURL>sample string 18</StoreURL>
    <UpdatedDate>2024-09-19T08:33:57.8920697+00:00</UpdatedDate>
  </OrderGridViewModel>
</ArrayOfOrderGridViewModel>