# ProductListing

    <p>A ProductListing resource represents a <a href="/docs/admin-api/rest/reference/products/product">Product</a> which is available
    to your sales channel. Merchants can make products available to your sales channel directly from their Shopify
    admin.</p>

    <p>You can use this resource to retrieve products that a merchant has published and display them to customers in
    your marketplace for sale.</p>

    <p>A ProductListing resource itself is unable to have its attributes modified directly. The attributes of a
    ProductListing are inherited from the Product resource to which it is associated. Therefore, all attributes of a
    ProductListing should be considered <em>read-only</em>.</p>

    <p>A product can have one of the following statuses: <code>active</code>, <code>draft</code>, or <code>archived</code>.
    Draft and archived are considered non-active statuses. If you create a listing for a non-active product,
    then the product won't be published immediately. You must change the product status to active to make the product
    available on a sales channel.</p>

    <p>If the product is sold exclusively on subscription, then you can create a listing for the product only on an online store.</p>


## Resource Properties

### ProductListing

* product_id: The unique identifer of the product this listing is for. The primary key for this resource.
  * Type: x-string
  * Example: {"product_id"=>1053727709}
* body_html: The description of the product, complete with HTML formatting.
  * Type: x-string
  * Example: "It's the small iPod with a big idea: Video."
* created_at: The date and time when the product was created. The API returns this in ISO 8601.
  * Type: x-string
  * Example: "2012-02-15T15:12:21-05:00"
* handle: A human-friendly unique string for the Product automatically generated from its title.
  * Type: x-string
  * Example: "ipod-nano"
* images: A list of image objects, each one representing an image associated with the product.
  * Type: x-string
  * Example: [{"src"=>"http://example.com/burton.jpg"}]
* options: Custom product property names like "Size", "Color", and "Material".
  * Type: x-string
  * Example: [{"name"=>"Title"}]
* product_type: A categorization that a product can be tagged with, commonly used for filtering.
  * Type: x-string
  * Example: "Cult Products"
* published_at: The date and time when the product was published. The API returns this in ISO 8601.
  * Type: x-string
  * Example: "2007-12-31T19:00:00-05:00"
* tags: A categorization that a product can be tagged with, commonly used for filtering.
  * Type: x-string
  * Example: "Emotive, Flash Memory, MP3, Music"
* title: The name of the product.
  * Type: x-string
  * Example: "IPod Nano - 8GB"
* updated_at: The date and time when the product was last modified. The API returns this in ISO 8601.
  * Type: x-string
  * Example: "2012-08-24T14:01:47-04:00"
* variants:         <p>A list of variant objects, each one representing a slightly different version of the product. For example, if a product comes in different sizes and colors, each size and color permutation (such as "small black", "medium black", "large blue"), would be a variant.</p>
        <p>To reorder variants, update the product with the variants in the desired order. The position attribute on the variant will be ignored.</p>
        <ul>
          <li><strong>barcode</strong>: The barcode, UPC or ISBN number for the product.</li>
          <li><strong>compare_at_price</strong>: The competitor's price for the same item.</li>
          <li><strong>created_at</strong>: The date and time when the product variant was created. The API returns this in ISO 8601.</li>
          <li><Strong>fulfillment_service</Strong>: Service which is handling fulfillment. Valid values are: <code>manual</code>, <code>gift_card</code>, or the handle of a <a href="/docs/admin-api/rest/reference/shipping-and-fulfillment/fulfillmentservice">FulfillmentService</a>.</li>
          <li><strong>grams</strong>: The weight of the product variant in grams.</li>
          <li><strong>weight</strong>: The weight of the product variant in the unit system specified with <strong>weight_unit</strong>.</li>
          <li><strong>weight_unit</strong>: The unit system that the product variant's weight is measure in. The weight_unit can be either "g", "kg, "oz", or "lb".</li>
          <li><strong>id</strong>: The unique numeric identifier for the product variant.</li>
          <li><strong>inventory_management</strong>: Specifies whether or not Shopify tracks the number of items in stock for this product variant.</li>
          <li><strong>inventory_policy</strong>: Specifies whether or not customers are allowed to place an order for a product variant when it's out of stock.</li>
          <li><strong>inventory_quantity</strong>: The number of items available to the product listing for the product variant.</li>
          <li><strong>metafield</strong>: Attaches additional information to a shop's resources.</li>
          <li><strong>option</strong>: Custom properties that a shop owner can use to define product variants. Multiple options can exist. Options are represented as: <code>option1</code>, <code>option2</code>, <code>option3</code>, etc.</li>
          <li><strong>position</strong>: The order of the product variant in the list of product variants. 1 is the first position. To reorder variants, update the product with the variants in the desired order. The position attribute on the variant will be ignored.</li>
          <li><strong>price</strong>: The price of the product variant.</li>
          <li><strong>product_id</strong>: The unique numeric identifier for the product.</li>
          <li><strong>requires_shipping</strong>: Specifies whether or not a customer needs to provide a shipping address when placing an order for this product variant.</li>
          <li><strong>sku</strong>: A unique identifier for the product in the shop.</li>
          <li><strong>taxable</strong>: Specifies whether or not a tax is charged when the product variant is sold.</li>
          <li><strong>title</strong>: The title of the product variant.</li>
          <li><strong>updated_at</strong>: The date and time when the product variant was last modified. The API returns this in ISO 8601.</li>
        </ul>

  * Type: x-string
  * Example: {"barcode"=>"1234_pink", "compare_at_price"=>nil, "created_at"=>"2012-08-24T14:01:47-04:00", "fulfillment_service"=>"manual", "grams"=>567, "weight"=>0.2, "weight_unit"=>"kg", "id"=>808950810, "inventory_management"=>"shopify", "inventory_policy"=>"continue", "inventory_quantity"=>10, "option1"=>"Pink", "position"=>1, "price"=>199.99, "product_id"=>632910392, "requires_shipping"=>true, "sku"=>"IPOD2008PINK", "taxable"=>true, "title"=>"Pink", "updated_at"=>"2012-08-24T14:01:47-04:00"}
* vendor: The name of the vendor of the product.
  * Type: x-string
  * Example: "Apple"
## Retrieve product listings that are published to your app

Retrieve product listings that are published to your app. <strong>Note:</strong> This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to <a href='/api/usage/pagination-rest'>Make paginated requests to the REST Admin API</a>.

### Endpoint
/admin/api/#{api_version}/product_listings.json (GET)

### Parameters
* api_version (required): 
* collection_id: Filter by products belonging to a particular collection
* handle: Filter by product handle
* limit: Amount of results
* product_ids: A comma-separated list of product ids
* updated_at_min: Filter by product listings last updated after a certain date and time (formatted in ISO 8601)

### Responses
#### 200
Retrieve product listings that are published to your app

Examples:
##### Retrieve product listings that are published to your app
Request:
```
GET /admin/api/unstable/product_listings.json
```

Response:
```
HTTP/1.1 200 OK
{"product_listings":[{"product_id":632910392,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00","body_html":"<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>","handle":"ipod-nano","product_type":"Cult Products","title":"IPod Nano - 8GB","vendor":"Apple","available":true,"tags":"Emotive, Flash Memory, MP3, Music","published_at":"2017-08-31T20:00:00-04:00","variants":[{"id":808950810,"title":"Pink","option_values":[{"option_id":594680422,"name":"Color","value":"Pink"}],"price":"199.00","formatted_price":"$199.00","compare_at_price":null,"grams":567,"requires_shipping":true,"sku":"IPOD2008PINK","barcode":"1234_pink","taxable":true,"position":1,"available":true,"inventory_policy":"continue","inventory_quantity":10,"inventory_management":"shopify","fulfillment_service":"manual","weight":1.25,"weight_unit":"lb","image_id":562641783,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00"},{"id":49148385,"title":"Red","option_values":[{"option_id":594680422,"name":"Color","value":"Red"}],"price":"199.00","formatted_price":"$199.00","compare_at_price":null,"grams":567,"requires_shipping":true,"sku":"IPOD2008RED","barcode":"1234_red","taxable":true,"position":2,"available":true,"inventory_policy":"continue","inventory_quantity":20,"inventory_management":"shopify","fulfillment_service":"manual","weight":1.25,"weight_unit":"lb","image_id":null,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00"},{"id":39072856,"title":"Green","option_values":[{"option_id":594680422,"name":"Color","value":"Green"}],"price":"199.00","formatted_price":"$199.00","compare_at_price":null,"grams":567,"requires_shipping":true,"sku":"IPOD2008GREEN","barcode":"1234_green","taxable":true,"position":3,"available":true,"inventory_policy":"continue","inventory_quantity":30,"inventory_management":"shopify","fulfillment_service":"manual","weight":1.25,"weight_unit":"lb","image_id":null,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00"},{"id":457924702,"title":"Black","option_values":[{"option_id":594680422,"name":"Color","value":"Black"}],"price":"199.00","formatted_price":"$199.00","compare_at_price":null,"grams":567,"requires_shipping":true,"sku":"IPOD2008BLACK","barcode":"1234_black","taxable":true,"position":4,"available":true,"inventory_policy":"continue","inventory_quantity":40,"inventory_management":"shopify","fulfillment_service":"manual","weight":1.25,"weight_unit":"lb","image_id":null,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00"}],"images":[{"id":850703190,"created_at":"2024-10-22T18:51:23-04:00","position":1,"updated_at":"2024-10-22T18:51:23-04:00","product_id":632910392,"src":"https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1729637483","variant_ids":[],"width":123,"height":456},{"id":562641783,"created_at":"2024-10-22T18:51:23-04:00","position":2,"updated_at":"2024-10-22T18:51:23-04:00","product_id":632910392,"src":"https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano-2.png?v=1729637483","variant_ids":[808950810],"width":123,"height":456},{"id":378407906,"created_at":"2024-10-22T18:51:23-04:00","position":3,"updated_at":"2024-10-22T18:51:23-04:00","product_id":632910392,"src":"https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1729637483","variant_ids":[],"width":123,"height":456}],"options":[{"id":594680422,"name":"Color","product_id":632910392,"position":1,"values":["Pink","Red","Green","Black"]}]},{"product_id":921728736,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00","body_html":"<p>The iPod Touch has the iPhone's multi-touch interface, with a physical home button off the touch screen. The home screen has a list of buttons for the available applications.</p>","handle":"ipod-touch","product_type":"Cult Products","title":"IPod Touch 8GB","vendor":"Apple","available":true,"tags":"","published_at":"2017-08-31T20:00:00-04:00","variants":[{"id":447654529,"title":"Black","option_values":[{"option_id":891236591,"name":"Title","value":"Black"}],"price":"199.00","formatted_price":"$199.00","compare_at_price":null,"grams":567,"requires_shipping":true,"sku":"IPOD2009BLACK","barcode":"1234_black","taxable":true,"position":1,"available":true,"inventory_policy":"continue","inventory_quantity":13,"inventory_management":"shopify","fulfillment_service":"manual","weight":1.25,"weight_unit":"lb","image_id":null,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00"}],"images":[],"options":[{"id":891236591,"name":"Title","product_id":921728736,"position":1,"values":["Black"]}]}]}
```
## Retrieve <code>product_ids</code> that are published to your app

Retrieve <code>product_ids</code> that are published to your app. Maximum 1,000 results per page.

### Endpoint
/admin/api/#{api_version}/product_listings/product_ids.json (GET)

### Parameters
* api_version (required): 
* limit: Amount of results

### Responses
#### 200
Retrieve <code>product_ids</code> that are published to your app

Examples:
##### Retrieve <code>product_ids</code> that are published to your app
Request:
```
GET /admin/api/unstable/product_listings/product_ids.json
```

Response:
```
HTTP/1.1 200 OK
{"product_ids":[921728736,632910392]}
```
## Retrieve a count of products that are published to your app

Retrieve a count of products that are published to your app

### Endpoint
/admin/api/#{api_version}/product_listings/count.json (GET)

### Parameters
* api_version (required): 

### Responses
#### 200
Retrieve a count of products that are published to your app

Examples:
##### Retrieve a count of products that are published to your app
Request:
```
GET /admin/api/unstable/product_listings/count.json
```

Response:
```
HTTP/1.1 200 OK
{"count":2}
```
## Retrieve a specific product listing that is published to your app

Retrieve a specific product listing that is published to your app

### Endpoint
/admin/api/#{api_version}/product_listings/{product_listing_id}.json (GET)

### Parameters
* api_version (required): 
* product_listing_id (required): 

### Responses
#### 200
Retrieve a specific product listing that is published to your app

Examples:
##### Retrieve a specific product listing that is published to your app
Request:
```
GET /admin/api/unstable/product_listings/921728736.json
```

Response:
```
HTTP/1.1 200 OK
{"product_listing":{"product_id":921728736,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00","body_html":"<p>The iPod Touch has the iPhone's multi-touch interface, with a physical home button off the touch screen. The home screen has a list of buttons for the available applications.</p>","handle":"ipod-touch","product_type":"Cult Products","title":"IPod Touch 8GB","vendor":"Apple","available":true,"tags":"","published_at":"2017-08-31T20:00:00-04:00","variants":[{"id":447654529,"title":"Black","option_values":[{"option_id":891236591,"name":"Title","value":"Black"}],"price":"199.00","formatted_price":"$199.00","compare_at_price":null,"grams":567,"requires_shipping":true,"sku":"IPOD2009BLACK","barcode":"1234_black","taxable":true,"position":1,"available":true,"inventory_policy":"continue","inventory_quantity":13,"inventory_management":"shopify","fulfillment_service":"manual","weight":1.25,"weight_unit":"lb","image_id":null,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00"}],"images":[],"options":[{"id":891236591,"name":"Title","product_id":921728736,"position":1,"values":["Black"]}]}}
```
## Create a product listing to publish a product to your app

Create a product listing to publish a product to your app

### Endpoint
/admin/api/#{api_version}/product_listings/{product_listing_id}.json (PUT)

### Parameters
* api_version (required): 
* product_listing_id (required): 

### Responses
#### 200
Create a product listing to publish a product to your app

Examples:
##### Create a product listing to publish a product to your app
Request:
```
PUT /admin/api/unstable/product_listings/921728736.json
{"product_listing":{"product_id":921728736}}
```

Response:
```
HTTP/1.1 200 OK
{"product_listing":{"product_id":921728736,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00","body_html":"<p>The iPod Touch has the iPhone's multi-touch interface, with a physical home button off the touch screen. The home screen has a list of buttons for the available applications.</p>","handle":"ipod-touch","product_type":"Cult Products","title":"IPod Touch 8GB","vendor":"Apple","available":true,"tags":"","published_at":"2017-08-31T20:00:00-04:00","variants":[{"id":447654529,"title":"Black","option_values":[{"option_id":891236591,"name":"Title","value":"Black"}],"price":"199.00","formatted_price":"$199.00","compare_at_price":null,"grams":567,"requires_shipping":true,"sku":"IPOD2009BLACK","barcode":"1234_black","taxable":true,"position":1,"available":true,"inventory_policy":"continue","inventory_quantity":13,"inventory_management":"shopify","fulfillment_service":"manual","weight":1.25,"weight_unit":"lb","image_id":null,"created_at":"2024-10-22T18:51:23-04:00","updated_at":"2024-10-22T18:51:23-04:00"}],"images":[],"options":[{"id":891236591,"name":"Title","product_id":921728736,"position":1,"values":["Black"]}]}}
```
## Delete a product listing to unpublish a product from your app

Delete a product listing to unpublish a product from your app

### Endpoint
/admin/api/#{api_version}/product_listings/{product_listing_id}.json (DELETE)

### Parameters
* api_version (required): 
* product_listing_id (required): 

### Responses
#### 200
Delete a product listing to unpublish a product from your app

Examples:
##### Delete a product listing to unpublish a product from your app
Request:
```
DELETE /admin/api/unstable/product_listings/921728736.json
```

Response:
```
HTTP/1.1 200 OK

```