GET listings/summary?ChannelId={ChannelId}&IncludeInactiveListings={IncludeInactiveListings}&PageSize={PageSize}&Page={Page}

Returns summary information about Listings matching the filter information provided.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ChannelId This is an optional parameter. Set it to only return orders for a given Channel. You can get a list of channels from the channels endpoint. integer Matching regular expression pattern: ^[1-9]\d*$
IncludeInactiveListings This is an optional parameter. Set it if you wish to include inactive listings to the results. boolean None.
PageSize This is an optional parameter. This will default to 100. The max page size is 10 000. integer Range: inclusive between 1 and 10000
Page This is an optional parameter. It will default to page 1. integer Matching regular expression pattern: ^[1-9]\d*$

Body Parameters

None.

Response Information

Resource Description

Returns summary information about Listings matching the filter information provided.

PagedResponseModelOfListingSummaryModel
NameDescriptionTypeAdditional information
TotalItems integer None.
PagingInfo PagingFilter None.
TotalPages integer None.
Data Collection of ListingSummaryModel None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalItems": 10,
  "PagingInfo": {
    "MaxPageSize": 100,
    "PageSize": 1,
    "Page": 1
  },
  "TotalPages": 10,
  "Data": [
    {
      "ListingId": 123,
      "ListingSku": "SKU-AB-2018",
      "ListingName": "Listing Name",
      "ListingPrice": 9.99,
      "ListingStatus": "ActiveOnChannel",
      "ChannelIdentifier": "CH-AB-2018",
      "ChannelName": "Channel Name",
      "ChannelId": 12345,
      "ProductSku": "SKU 1",
      "ProductEan": "9780471117094",
      "ProductInventory": 1,
      "IsActive": true
    }
  ]
}

application/xml, text/xml

Sample: 
<PagedListingSummaryModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalItems>10</TotalItems>
  <PagingInfo>
    <PageSize>1</PageSize>
    <Page>1</Page>
  </PagingInfo>
  <TotalPages>10</TotalPages>
  <Data>
    <ListingSummaryModel>
      <ListingId>123</ListingId>
      <ListingSku>SKU-AB-2018</ListingSku>
      <ListingName>Listing Name</ListingName>
      <ListingPrice>9.99</ListingPrice>
      <ListingStatus>ActiveOnChannel</ListingStatus>
      <ChannelIdentifier>CH-AB-2018</ChannelIdentifier>
      <ChannelName>Channel Name</ChannelName>
      <ChannelId>12345</ChannelId>
      <ProductSku>SKU 1</ProductSku>
      <ProductEan>9780471117094</ProductEan>
      <ProductInventory>1</ProductInventory>
      <IsActive>true</IsActive>
    </ListingSummaryModel>
  </Data>
</PagedListingSummaryModel>