GET listings?ChannelID={ChannelID}&ChannelIdentifier={ChannelIdentifier}&ListingSKU={ListingSKU}&ProductSKU={ProductSKU}&PriceFrom={PriceFrom}&PriceTo={PriceTo}&ListingStatus={ListingStatus}&CreatedDateFrom={CreatedDateFrom}&CreatedDateTo={CreatedDateTo}&PageSize={PageSize}&Page={Page}
Returns information about multiple Listings matching the filter information provided.
Request Information
URI Parameters
Name | Description | Type | Additional 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*$ |
ChannelIdentifier | This is an optional parameter. Set it to only get Listings of a particular Listing Channel Identifier. | string | None. |
ListingSKU | This is an optional parameter. Set it to only get Listings of a particular Listing SKU. | string | None. |
ProductSKU | This is an optional parameter. Set it to only get Listings of a particular Product SKU. | string | None. |
PriceFrom | This is an optional parameter. Set it to only get Listings with Price greater or equal to the provided value. | decimal number | None. |
PriceTo | This is an optional parameter. Set it to only get Listings with Price less or equal to the provided value. | decimal number | None. |
ListingStatus | This is an optional parameter. Set it to get listings in a certain status. | ProductChannelStatus | None. |
CreatedDateFrom | This is an optional parameter. It is the created date to search from. | date | None. |
CreatedDateTo | This is an optional parameter. It is the created date to search to. | date | None. |
PageSize | This is an optional parameter. This will default to 100. The max page size is 100. | integer | Range: inclusive between 1 and 100 |
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 information about multiple Listings matching the filter information provided.
PagedResponseModelOfListingModelName | Description | Type | Additional information |
---|---|---|---|
TotalItems | integer | None. | |
PagingInfo | PagingFilter | None. | |
TotalPages | integer | None. | |
Data | Collection of ListingModel | None. |
Response Formats
application/json, text/json
Sample:
{ "TotalItems": 10, "PagingInfo": { "PageSize": 1, "Page": 1 }, "TotalPages": 10, "Data": [ { "ListingID": 123, "ListingSKU": "SKU-AB-2018", "ListingBarcode": "12345678", "ListingName": "Listing Name", "ListingPrice": 9.99, "ListingDescription": "A description string", "ListingOversell": 3, "ListingMaxInventory": 10, "ListingInventoryType": "InventoryOversell", "ListingInventoryPercentage": 100, "ListingStatus": "ActiveOnChannel", "ChannelIdentifier": "CH-AB-2018", "Channel": { "ChannelName": "Shopify UK", "ChannelType": "Shopify", "ChannelID": 1, "ChannelGuid": "8472a940-c594-4054-a048-a3c1e79a9e4f", "IsActive": false }, "Product": { "Categories": [ { "CategoryID": 1, "CategoryName": "Shoes" }, { "CategoryID": 2, "CategoryName": "Trainers" } ], "ProductID": 1, "SKU": "SKU 1" } } ] }
application/xml, text/xml
Sample:
<PagedListingModel 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> <ListingModel> <ListingID>123</ListingID> <CreatedDate xsi:nil="true" /> <ListingSKU>SKU-AB-2018</ListingSKU> <ListingBarcode>12345678</ListingBarcode> <ListingName>Listing Name</ListingName> <ListingPrice>9.99</ListingPrice> <ListingDescription>A description string</ListingDescription> <ListingOversell>3</ListingOversell> <ListingMaxInventory>10</ListingMaxInventory> <ListingInventoryType>InventoryOversell</ListingInventoryType> <ListingInventoryPercentage>100</ListingInventoryPercentage> <ListingStatus>ActiveOnChannel</ListingStatus> <ChannelIdentifier>CH-AB-2018</ChannelIdentifier> <Channel> <ChannelName>Shopify UK</ChannelName> <ChannelType>Shopify</ChannelType> <ChannelID>1</ChannelID> <ChannelGuid>8472a940-c594-4054-a048-a3c1e79a9e4f</ChannelGuid> <IsActive>false</IsActive> </Channel> <Product> <ProductID>1</ProductID> <SKU>SKU 1</SKU> <Categories> <CategoryBaseModel> <CategoryID>1</CategoryID> <CategoryName>Shoes</CategoryName> </CategoryBaseModel> <CategoryBaseModel> <CategoryID>2</CategoryID> <CategoryName>Trainers</CategoryName> </CategoryBaseModel> </Categories> </Product> </ListingModel> </Data> </PagedListingModel>