GET api/WebApiOdata/GetOrdersForOrderPayout?providerID={providerID}&searchString={searchString}

Request Information

URI Parameters

Name	Description	Type	Additional information
providerID		integer	Required
searchString		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of SalesByOrderlineViewModelReport

Name	Type	Additional information
StoreName	string	None.
OrderNumber	string	None.
OrderLineNumber	integer	None.
OrderDate	string	None.
ShopperUserName	string	None.
CompanyName	string	None.
PreferredGroupName	string	None.
SupplierName	string	None.
Brand	string	None.
OrderlineStatus	string	None.
ShippingMethod	string	None.
ProductCode	string	None.
ManfID	string	None.
ProductSKU	string	None.
ManfSKU	string	None.
ProductName	string	None.
Options	string	None.
DownloadOptions	string	None.
Quantity	integer	None.
SupplierID	integer	None.
SCProductID	integer	None.
ItemPrice	decimal number	None.
TotalLineItemPrice	decimal number	None.
ShippingAmount	decimal number	None.
TaxAmount	decimal number	None.
SubTotal	decimal number	None.
CouponAmount	decimal number	None.
UsedCouponAmount	decimal number	None.
EmbellishmentPrice	decimal number	None.
DisplayItemPrice	string	None.
DisplayTotalLineItemPrice	string	None.
DisplayShippingAmount	string	None.
DisplayTotalTax	string	None.
DisplaySubTotal	string	None.
DisplayCouponAmount	string	None.
DisplayEmbellishmentPrice	string	None.
DisplayUsedCouponAmount	string	None.
ShippingAddress	string	None.
BillingAddress	string	None.
ShippingAddressline1	string	None.
ShippingAddressline2	string	None.
ShippingAddressCity	string	None.
ShippingAddressStateCode	string	None.
ShippingAddressCountryCode	string	None.
ShippingAddressZipCode	string	None.
BillingAddressline1	string	None.
BillingAddressline2	string	None.
BillingAddressCity	string	None.
BillingAddressStateCode	string	None.
BillingAddressCountryCode	string	None.
BillingAddressZipCode	string	None.
PONumber	string	None.
Embellishment	string	None.
EmbellishmentDetail	string	None.
_displayCouponAmount	string	None.
_displayEmbellishmentPrice	string	None.
_displayUsedCouponAmount	string	None.
PayoutStatus	string	None.
PayoutDate	date	None.
PayoutNotes	string	None.
PayoutValue	decimal number	None.
OrderItemID	integer	None.
CommissionOrderPayoutID	integer	None.
EmbellishmentInfo	string	None.
_EmbellishmentDetail	string	None.
DownloadEmbellishment	string	None.
OrderNumberDisplay	string	None.
OrderNote	string	None.
OrderLineNote	string	None.
ERPNumber	string	None.
ShippedCity	string	None.
ShippedState	string	None.
ShippedDate	string	None.
TrackingInfo	string	None.
Dropship	string	None.
CouponCode	string	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "StoreName": "sample string 1",
    "OrderNumber": "sample string 2",
    "OrderLineNumber": 3,
    "OrderDate": "sample string 4",
    "ShopperUserName": "sample string 5",
    "CompanyName": "sample string 6",
    "PreferredGroupName": "sample string 7",
    "SupplierName": "sample string 8",
    "Brand": "sample string 9",
    "OrderlineStatus": "sample string 10",
    "ShippingMethod": "sample string 11",
    "ProductCode": "sample string 12",
    "ManfID": "sample string 13",
    "ProductSKU": "sample string 14",
    "ManfSKU": "sample string 15",
    "ProductName": "sample string 16",
    "Options": "sample string 17",
    "DownloadOptions": "sample string 17",
    "Quantity": 19,
    "SupplierID": 20,
    "SCProductID": 21,
    "ItemPrice": 1.1,
    "TotalLineItemPrice": 1.1,
    "ShippingAmount": 1.1,
    "TaxAmount": 1.1,
    "SubTotal": 1.1,
    "CouponAmount": 1.1,
    "UsedCouponAmount": 1.1,
    "EmbellishmentPrice": 1.1,
    "DisplayItemPrice": "$1.10",
    "DisplayTotalLineItemPrice": "$1.10",
    "DisplayShippingAmount": "$1.10",
    "DisplayTotalTax": "$1.10",
    "DisplaySubTotal": "$1.10",
    "DisplayCouponAmount": "$1.10",
    "DisplayEmbellishmentPrice": "$1.10",
    "DisplayUsedCouponAmount": "$1.10",
    "ShippingAddress": "sample string 30",
    "BillingAddress": "sample string 31",
    "ShippingAddressline1": "sample string 32",
    "ShippingAddressline2": "sample string 33",
    "ShippingAddressCity": "sample string 34",
    "ShippingAddressStateCode": "sample string 35",
    "ShippingAddressCountryCode": "sample string 36",
    "ShippingAddressZipCode": "sample string 37",
    "BillingAddressline1": "sample string 38",
    "BillingAddressline2": "sample string 39",
    "BillingAddressCity": "sample string 40",
    "BillingAddressStateCode": "sample string 41",
    "BillingAddressCountryCode": "sample string 42",
    "BillingAddressZipCode": "sample string 43",
    "PONumber": "sample string 44",
    "Embellishment": "sample string 45",
    "EmbellishmentDetail": "sample string 46",
    "_displayCouponAmount": "sample string 47",
    "_displayEmbellishmentPrice": "sample string 48",
    "_displayUsedCouponAmount": "sample string 49",
    "PayoutStatus": "sample string 50",
    "PayoutDate": "1/22/2025",
    "PayoutNotes": "sample string 51",
    "PayoutValue": 1.1,
    "OrderItemID": 52,
    "CommissionOrderPayoutID": 53,
    "EmbellishmentInfo": "sample string 45",
    "_EmbellishmentDetail": "",
    "DownloadEmbellishment": "",
    "OrderNumberDisplay": "sample string 2",
    "OrderNote": "sample string 55",
    "OrderLineNote": "sample string 56",
    "ERPNumber": "sample string 57",
    "ShippedCity": "sample string 58",
    "ShippedState": "sample string 59",
    "ShippedDate": "sample string 60",
    "TrackingInfo": "sample string 61",
    "Dropship": "sample string 62",
    "CouponCode": "sample string 63"
  },
  {
    "StoreName": "sample string 1",
    "OrderNumber": "sample string 2",
    "OrderLineNumber": 3,
    "OrderDate": "sample string 4",
    "ShopperUserName": "sample string 5",
    "CompanyName": "sample string 6",
    "PreferredGroupName": "sample string 7",
    "SupplierName": "sample string 8",
    "Brand": "sample string 9",
    "OrderlineStatus": "sample string 10",
    "ShippingMethod": "sample string 11",
    "ProductCode": "sample string 12",
    "ManfID": "sample string 13",
    "ProductSKU": "sample string 14",
    "ManfSKU": "sample string 15",
    "ProductName": "sample string 16",
    "Options": "sample string 17",
    "DownloadOptions": "sample string 17",
    "Quantity": 19,
    "SupplierID": 20,
    "SCProductID": 21,
    "ItemPrice": 1.1,
    "TotalLineItemPrice": 1.1,
    "ShippingAmount": 1.1,
    "TaxAmount": 1.1,
    "SubTotal": 1.1,
    "CouponAmount": 1.1,
    "UsedCouponAmount": 1.1,
    "EmbellishmentPrice": 1.1,
    "DisplayItemPrice": "$1.10",
    "DisplayTotalLineItemPrice": "$1.10",
    "DisplayShippingAmount": "$1.10",
    "DisplayTotalTax": "$1.10",
    "DisplaySubTotal": "$1.10",
    "DisplayCouponAmount": "$1.10",
    "DisplayEmbellishmentPrice": "$1.10",
    "DisplayUsedCouponAmount": "$1.10",
    "ShippingAddress": "sample string 30",
    "BillingAddress": "sample string 31",
    "ShippingAddressline1": "sample string 32",
    "ShippingAddressline2": "sample string 33",
    "ShippingAddressCity": "sample string 34",
    "ShippingAddressStateCode": "sample string 35",
    "ShippingAddressCountryCode": "sample string 36",
    "ShippingAddressZipCode": "sample string 37",
    "BillingAddressline1": "sample string 38",
    "BillingAddressline2": "sample string 39",
    "BillingAddressCity": "sample string 40",
    "BillingAddressStateCode": "sample string 41",
    "BillingAddressCountryCode": "sample string 42",
    "BillingAddressZipCode": "sample string 43",
    "PONumber": "sample string 44",
    "Embellishment": "sample string 45",
    "EmbellishmentDetail": "sample string 46",
    "_displayCouponAmount": "sample string 47",
    "_displayEmbellishmentPrice": "sample string 48",
    "_displayUsedCouponAmount": "sample string 49",
    "PayoutStatus": "sample string 50",
    "PayoutDate": "1/22/2025",
    "PayoutNotes": "sample string 51",
    "PayoutValue": 1.1,
    "OrderItemID": 52,
    "CommissionOrderPayoutID": 53,
    "EmbellishmentInfo": "sample string 45",
    "_EmbellishmentDetail": "",
    "DownloadEmbellishment": "",
    "OrderNumberDisplay": "sample string 2",
    "OrderNote": "sample string 55",
    "OrderLineNote": "sample string 56",
    "ERPNumber": "sample string 57",
    "ShippedCity": "sample string 58",
    "ShippedState": "sample string 59",
    "ShippedDate": "sample string 60",
    "TrackingInfo": "sample string 61",
    "Dropship": "sample string 62",
    "CouponCode": "sample string 63"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSalesByOrderlineViewModelReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SellersCommerce.ViewModels.Reports">
  <SalesByOrderlineViewModelReport>
    <BillingAddress>sample string 31</BillingAddress>
    <BillingAddressCity>sample string 40</BillingAddressCity>
    <BillingAddressCountryCode>sample string 42</BillingAddressCountryCode>
    <BillingAddressStateCode>sample string 41</BillingAddressStateCode>
    <BillingAddressZipCode>sample string 43</BillingAddressZipCode>
    <BillingAddressline1>sample string 38</BillingAddressline1>
    <BillingAddressline2>sample string 39</BillingAddressline2>
    <Brand>sample string 9</Brand>
    <CommissionOrderPayoutID>53</CommissionOrderPayoutID>
    <CompanyName>sample string 6</CompanyName>
    <CouponAmount>1.1</CouponAmount>
    <CouponCode>sample string 63</CouponCode>
    <DisplayCouponAmount>$1.10</DisplayCouponAmount>
    <DisplayEmbellishmentPrice>$1.10</DisplayEmbellishmentPrice>
    <DisplayItemPrice>$1.10</DisplayItemPrice>
    <DisplayShippingAmount>$1.10</DisplayShippingAmount>
    <DisplaySubTotal>$1.10</DisplaySubTotal>
    <DisplayTotalLineItemPrice>$1.10</DisplayTotalLineItemPrice>
    <DisplayTotalTax>$1.10</DisplayTotalTax>
    <DisplayUsedCouponAmount>$1.10</DisplayUsedCouponAmount>
    <DownloadOptions>sample string 17</DownloadOptions>
    <Dropship>sample string 62</Dropship>
    <ERPNumber>sample string 57</ERPNumber>
    <Embellishment>sample string 45</Embellishment>
    <EmbellishmentDetail>sample string 46</EmbellishmentDetail>
    <EmbellishmentInfo>sample string 45</EmbellishmentInfo>
    <EmbellishmentPrice>1.1</EmbellishmentPrice>
    <ItemPrice>1.1</ItemPrice>
    <ManfID>sample string 13</ManfID>
    <ManfSKU>sample string 15</ManfSKU>
    <Options>sample string 17</Options>
    <OrderDate>sample string 4</OrderDate>
    <OrderItemID>52</OrderItemID>
    <OrderLineNote>sample string 56</OrderLineNote>
    <OrderLineNumber>3</OrderLineNumber>
    <OrderNote>sample string 55</OrderNote>
    <OrderNumber>sample string 2</OrderNumber>
    <OrderlineStatus>sample string 10</OrderlineStatus>
    <PONumber>sample string 44</PONumber>
    <PayoutDate>2025-01-22T13:46:48.301203+00:00</PayoutDate>
    <PayoutNotes>sample string 51</PayoutNotes>
    <PayoutStatus>sample string 50</PayoutStatus>
    <PayoutValue>1.1</PayoutValue>
    <PreferredGroupName>sample string 7</PreferredGroupName>
    <ProductCode>sample string 12</ProductCode>
    <ProductName>sample string 16</ProductName>
    <ProductSKU>sample string 14</ProductSKU>
    <Quantity>19</Quantity>
    <SCProductID>21</SCProductID>
    <ShippedCity>sample string 58</ShippedCity>
    <ShippedDate>sample string 60</ShippedDate>
    <ShippedState>sample string 59</ShippedState>
    <ShippingAddress>sample string 30</ShippingAddress>
    <ShippingAddressCity>sample string 34</ShippingAddressCity>
    <ShippingAddressCountryCode>sample string 36</ShippingAddressCountryCode>
    <ShippingAddressStateCode>sample string 35</ShippingAddressStateCode>
    <ShippingAddressZipCode>sample string 37</ShippingAddressZipCode>
    <ShippingAddressline1>sample string 32</ShippingAddressline1>
    <ShippingAddressline2>sample string 33</ShippingAddressline2>
    <ShippingAmount>1.1</ShippingAmount>
    <ShippingMethod>sample string 11</ShippingMethod>
    <ShopperUserName>sample string 5</ShopperUserName>
    <StoreName>sample string 1</StoreName>
    <SubTotal>1.1</SubTotal>
    <SupplierID>20</SupplierID>
    <SupplierName>sample string 8</SupplierName>
    <TaxAmount>1.1</TaxAmount>
    <TotalLineItemPrice>1.1</TotalLineItemPrice>
    <TrackingInfo>sample string 61</TrackingInfo>
    <UsedCouponAmount>1.1</UsedCouponAmount>
    <_displayCouponAmount>sample string 47</_displayCouponAmount>
    <_displayEmbellishmentPrice>sample string 48</_displayEmbellishmentPrice>
    <_displayUsedCouponAmount>sample string 49</_displayUsedCouponAmount>
  </SalesByOrderlineViewModelReport>
  <SalesByOrderlineViewModelReport>
    <BillingAddress>sample string 31</BillingAddress>
    <BillingAddressCity>sample string 40</BillingAddressCity>
    <BillingAddressCountryCode>sample string 42</BillingAddressCountryCode>
    <BillingAddressStateCode>sample string 41</BillingAddressStateCode>
    <BillingAddressZipCode>sample string 43</BillingAddressZipCode>
    <BillingAddressline1>sample string 38</BillingAddressline1>
    <BillingAddressline2>sample string 39</BillingAddressline2>
    <Brand>sample string 9</Brand>
    <CommissionOrderPayoutID>53</CommissionOrderPayoutID>
    <CompanyName>sample string 6</CompanyName>
    <CouponAmount>1.1</CouponAmount>
    <CouponCode>sample string 63</CouponCode>
    <DisplayCouponAmount>$1.10</DisplayCouponAmount>
    <DisplayEmbellishmentPrice>$1.10</DisplayEmbellishmentPrice>
    <DisplayItemPrice>$1.10</DisplayItemPrice>
    <DisplayShippingAmount>$1.10</DisplayShippingAmount>
    <DisplaySubTotal>$1.10</DisplaySubTotal>
    <DisplayTotalLineItemPrice>$1.10</DisplayTotalLineItemPrice>
    <DisplayTotalTax>$1.10</DisplayTotalTax>
    <DisplayUsedCouponAmount>$1.10</DisplayUsedCouponAmount>
    <DownloadOptions>sample string 17</DownloadOptions>
    <Dropship>sample string 62</Dropship>
    <ERPNumber>sample string 57</ERPNumber>
    <Embellishment>sample string 45</Embellishment>
    <EmbellishmentDetail>sample string 46</EmbellishmentDetail>
    <EmbellishmentInfo>sample string 45</EmbellishmentInfo>
    <EmbellishmentPrice>1.1</EmbellishmentPrice>
    <ItemPrice>1.1</ItemPrice>
    <ManfID>sample string 13</ManfID>
    <ManfSKU>sample string 15</ManfSKU>
    <Options>sample string 17</Options>
    <OrderDate>sample string 4</OrderDate>
    <OrderItemID>52</OrderItemID>
    <OrderLineNote>sample string 56</OrderLineNote>
    <OrderLineNumber>3</OrderLineNumber>
    <OrderNote>sample string 55</OrderNote>
    <OrderNumber>sample string 2</OrderNumber>
    <OrderlineStatus>sample string 10</OrderlineStatus>
    <PONumber>sample string 44</PONumber>
    <PayoutDate>2025-01-22T13:46:48.301203+00:00</PayoutDate>
    <PayoutNotes>sample string 51</PayoutNotes>
    <PayoutStatus>sample string 50</PayoutStatus>
    <PayoutValue>1.1</PayoutValue>
    <PreferredGroupName>sample string 7</PreferredGroupName>
    <ProductCode>sample string 12</ProductCode>
    <ProductName>sample string 16</ProductName>
    <ProductSKU>sample string 14</ProductSKU>
    <Quantity>19</Quantity>
    <SCProductID>21</SCProductID>
    <ShippedCity>sample string 58</ShippedCity>
    <ShippedDate>sample string 60</ShippedDate>
    <ShippedState>sample string 59</ShippedState>
    <ShippingAddress>sample string 30</ShippingAddress>
    <ShippingAddressCity>sample string 34</ShippingAddressCity>
    <ShippingAddressCountryCode>sample string 36</ShippingAddressCountryCode>
    <ShippingAddressStateCode>sample string 35</ShippingAddressStateCode>
    <ShippingAddressZipCode>sample string 37</ShippingAddressZipCode>
    <ShippingAddressline1>sample string 32</ShippingAddressline1>
    <ShippingAddressline2>sample string 33</ShippingAddressline2>
    <ShippingAmount>1.1</ShippingAmount>
    <ShippingMethod>sample string 11</ShippingMethod>
    <ShopperUserName>sample string 5</ShopperUserName>
    <StoreName>sample string 1</StoreName>
    <SubTotal>1.1</SubTotal>
    <SupplierID>20</SupplierID>
    <SupplierName>sample string 8</SupplierName>
    <TaxAmount>1.1</TaxAmount>
    <TotalLineItemPrice>1.1</TotalLineItemPrice>
    <TrackingInfo>sample string 61</TrackingInfo>
    <UsedCouponAmount>1.1</UsedCouponAmount>
    <_displayCouponAmount>sample string 47</_displayCouponAmount>
    <_displayEmbellishmentPrice>sample string 48</_displayEmbellishmentPrice>
    <_displayUsedCouponAmount>sample string 49</_displayUsedCouponAmount>
  </SalesByOrderlineViewModelReport>
</ArrayOfSalesByOrderlineViewModelReport>