PATCH listings/{listingID}

This call allows you to update a single listing by ID. A successful update will trigger updates on the channel if enabled in the channel settings.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
listingID The ID of the listing to update integer Required

Body Parameters

The update object with new data

ListingPatchModel
NameDescriptionTypeAdditional information
ListingID Which listing is being patched? Will be automatically set by the individual patch endpoint. Is required by the bulk patch endpoint. integer None.
Description Description. If null, then no chagnes are made. Validation on this field varies by channel. string None.
HandlingTimeDays Handling time in days for this listing (time to ship/dispatch), if null then no changes are made. Validation on this field varies by channel. integer None.
InventoryPercentage Inventory percentage (0-100) for this listing, if null then no changes are made integer None.
InventoryType Inventory type identifier, if null then no changes are made integer None.
MaxInventory Maximum inventory level for this listing, if null then no changes are made integer None.
Name Name, if null then no changes are made string None.
OutOfStockThreshold Out of stock threshold for this listing, if null then no changes are made integer None.
Oversell Amount of oversell allowed for this listing, if null then no changes are made integer None.
Price The listing price on the channel, if null then no changes are made decimal number None.
PricingProfileID Pricing prifile ID. If null, no changes are made. To remove the pricing profile, use the field RemovePricingProfile = true integer None.
RemovePricingProfile Use to remove the pricing profile completely, if null then no changes are made. If true, the pricing profile will be removed. boolean None.
SKU The listing SKU/identifier on the channel string None.

Request Formats

application/json, text/json

Sample: 
{
  "ListingID": 1,
  "Description": "sample string 1",
  "HandlingTimeDays": 1,
  "InventoryPercentage": 1,
  "InventoryType": 1,
  "MaxInventory": 1,
  "Name": "sample string 2",
  "OutOfStockThreshold": 1,
  "Oversell": 1,
  "Price": 1.0,
  "PricingProfileID": 1,
  "RemovePricingProfile": true,
  "SKU": "sample string 3"
}

application/xml, text/xml

Sample: 
<ListingPatchModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ListingID>1</ListingID>
  <Description>sample string 1</Description>
  <HandlingTimeDays>1</HandlingTimeDays>
  <InventoryPercentage>1</InventoryPercentage>
  <InventoryType>1</InventoryType>
  <MaxInventory>1</MaxInventory>
  <Name>sample string 2</Name>
  <OutOfStockThreshold>1</OutOfStockThreshold>
  <Oversell>1</Oversell>
  <Price>1</Price>
  <PricingProfileID>1</PricingProfileID>
  <RemovePricingProfile>true</RemovePricingProfile>
  <SKU>sample string 3</SKU>
</ListingPatchModel>

Response Information

Resource Description

This call allows you to update a single listing by ID. A successful update will trigger updates on the channel if enabled in the channel settings.

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": "Amazon UK",
    "ChannelType": "Amazon",
    "ChannelID": 1,
    "ChannelGuid": "fa65335e-eb7c-4a82-99ce-7e925366635a",
    "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>Amazon UK</ChannelName>
    <ChannelType>Amazon</ChannelType>
    <ChannelID>1</ChannelID>
    <ChannelGuid>fa65335e-eb7c-4a82-99ce-7e925366635a</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>