Sign in
latestSwagger 2.0ShopBase Dev 1.02026-08-10153268547.4 KB

353ccde6240d

Product

Retrieves a list of products of a collection.

get/admin/products/collections.json

Request body

collection_idinteger

Filter results by product collection ID.

created_at_maxstring

Show products created before date. (format: 2014-04-25T16:15:47-04:00)

created_at_minstring

Show products created after date. (format: 2014-04-25T16:15:47-04:00)

limitinteger

Return up to this many results per page. (default: 50, maximum: 250).

pageinteger

Using for pagination. (default: 1).

published_at_minstring

Show products published after date. (format: 2014-04-25T16:15:47-04:00)

published_statusstring

Return products by their published status. (default: any), published: Show only published products. unpublished: Show only unpublished products. any: Show all products.

since_idinteger

Restrict results to after the specified ID.

sort_orderstring

Order which is used to arranging items. (valid orders: alpha-asc, alpha-desc, created-asc, created-desc, price-asc, price-desc)

titlestring

Filter product by title

updated_at_maxstring

Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)

updated_at_minstring

Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)

Example request

{
  "collection_id": 123456,
  "created_at_max": "2014-04-25T16:15:47-04:00",
  "created_at_min": "2014-04-25T16:15:47-04:00",
  "limit": 10,
  "page": 1,
  "published_at_min": "2014-04-25T16:15:47-04:00",
  "published_status": "any",
  "since_id": 3456789,
  "sort_order": "alpha-asc",
  "title": "product",
  "updated_at_max": "2014-04-25T16:15:47-04:00",
  "updated_at_min": "2014-04-25T16:15:47-04:00"
}

Response

OK

totalinteger

Example response

{
  "products": [
    {
      "body_html": "<p>It's the small iPod with a big idea: Video.<p>",
      "handle": "ipod-nano-8gb",
      "id": 632910392,
      "metafields_global_description_tag": "It's the small iPod with a big idea: Video.",
      "metafields_global_title_tag": "IPod Nano - White, 8GB",
      "product_availability": 7,
      "product_type": "Cult Products",
      "published": true,
      "tags": "Emotive, Flash Memory, MP3, Music",
      "title": "IPod Nano - 8GB",
      "vendor": "Apple"
    }
  ],
  "total": 1
}