GET listings/{listingID}

Returns information about the Listing with the given Listing ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
listingID The ID of the Listing integer Required

Body Parameters

None.

Response Information

Resource Description

Returns information about the Listing with the given Listing ID.

ListingModel
NameDescriptionTypeAdditional information
ListingID The ID of the Listing integer None.
CreatedDate The Created Date of the Listing date None.
ListingSKU The SKU of the Listing string None.
ListingBarcode The Barcode of the Listing string None.
ListingName The name of the Listing string None.
ListingPrice The price of the Listing decimal number None.
ListingDescription The description of the Listing string None.
ListingOversell The oversell stock of the listing integer None.
ListingMaxInventory The maximum inventory for the listing integer None.
ListingInventoryType The inventory type of the listing InventoryType None.
ListingInventoryPercentage The inventory percentage to use for the listing integer None.
ListingStatus The status of the Listing ProductChannelStatus None.
ChannelIdentifier The Channel Identifier of the Listing string None.
Channel The Channel of the Listing ChannelBaseModel None.
Product The Product of the Listing ProductListingProductModel None.

Response Formats

application/json, text/json

Sample: 
{
  "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": "956b1c22-6d4a-4d03-9c22-728b6cb2f076",
    "IsActive": false
  },
  "Product": {
    "Categories": [
      {
        "CategoryID": 1,
        "CategoryName": "Shoes"
      },
      {
        "CategoryID": 2,
        "CategoryName": "Trainers"
      }
    ],
    "Ean": "9780471117094",
    "ProductID": 1,
    "SKU": "SKU 1"
  }
}

application/xml, text/xml

Sample: 
<ListingModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <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>956b1c22-6d4a-4d03-9c22-728b6cb2f076</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>
    <Ean>9780471117094</Ean>
  </Product>
</ListingModel>