GET v1​/ items​/list

Endpoint to get the Items by id.

Instant gratification

Do it yourself from console!

Assuming that you have a valid token previously exported into BEARER env variable and that 1 and 2 are the ID of two published Items.

Try to get the Items 1 and 2.
curl -i -H "Authorization: Bearer $BEARER" \
https://api.blomming.com/v1/items/list?id=1,2

Request

Example Request

{
  "currency": "EUR",
  "page": 2,
  "per_page": 5,
  "locale": "es",
  "id": 124224
}

Request Parameters

  • currency

    the currency to use when returning prices, the default is EUR.

    • Required: no
    • Type: string
    • Example: "EUR"
  • page

    The paginated results.

    • Required: no
    • Type: integer
    • Example: 2
  • per_page

    The number of results per page.

    • Required: no
    • Type: integer
    • Example: 5
  • locale

    The locale used in the results.

    • Required: no
    • Type: string
    • Example: "es"
  • id

    The id or the comma separated ids of the Item(s).

    • Required: no
    • Type: string
    • Example: 124224

Response

Example Response

[
  {
    "title": "Orecchini uncinetto handmade",
    "description": "A very very long description without HTML tags.",
    "raw_description": "A very very long description with HTML tags.",
    "url": "https://api.blomming.com/v1/shops/lozoodisimona/items/115538",
    "id": "115538",
    "price": 25.0,
    "original_price": 25.0,
    "quantity": 42,
    "photos": [
      "https://s3.amazonaws.com/cdn.blomming.com/items/000/179/591/large/f569f44564d8b35283783430638d03c2.jpg?1346100986"
    ],
    "created_at": "2012-08-27T20:56:36Z",
    "web_url": "http://blomming.com/mm/luciapw/items/orecchini-uncinetto-handmade--7",
    "fbcomments": "http://blomming.com/items/115538/fbcomments",
    "shop": {
      "id": "lozoodisimona",
      "url": "https://api.blomming.com/v1/shops/lozoodisimona",
      "name": "Lo Zoo di Simona",
      "image": {
      },
      "items_url": "http://example.org/shops/lozoodisimona/items"
    },
    "currency": "EUR"
  }
]

Response Parameters

  • Type: array
  • Items

    The list of the Items.

    • Required: yes
    • title

      The title of the Item.

      • Required: yes
      • Type: string
      • Example: "Orecchini uncinetto handmade"
    • description

      The description of the Item.

      • Required: yes
      • Type: string
      • Example: "A very very long description without HTML tags."
    • raw_description

      The description of the Item with html tags.

      • Required: yes
      • Type: string
      • Example: "A very very long description with HTML tags."
    • url

      The URL to fetch the details of the Item.

      • Required: yes
      • Type: string
      • Format: uri
      • Example: "https://api.blomming.com/v1/shops/lozoodisimona/items/115538"
    • id

      The id of this Item.

      • Required: yes
      • Type: string
      • Example: "115538"
    • price

      The price of this Item in the currency passed as parameter.

      • Required: yes
      • Type: string
      • Example: 25.0
    • original_price

      The origin (non-discounted) price of this Item in the currency passed as parameter.

      • Required: yes
      • Type:
        • string
        • null
      • Example: 25.0
    • quantity

      The number of Items present in the store.

      • Required: yes
      • Type: integer
      • Example: 42
    • photos

      The photo of this Item with resolution XxY.

      • Required: yes
      • Type: array
      • Items

        The URL of the photo.

        • Required: yes
        • Type: string
        • Format: uri
        • Example: "https://s3.amazonaws.com/cdn.blomming.com/items/000/179/591/large/f569f44564d8b35283783430638d03c2.jpg?1346100986"
    • created_at

      The date at which this Item has been created.

      • Required: yes
      • Type: string
      • Format: date-time
      • Example: "2012-08-27T20:56:36Z"
    • web_url

      The URL on the web of this resource.

      • Required: yes
      • Type: string
      • Format: uri
      • Example: "http://blomming.com/mm/luciapw/items/orecchini-uncinetto-handmade--7"
    • fbcomments

      The URL to display the facebook comments.

      • Required: yes
      • Type: string
      • Format: uri
      • Example: "http://blomming.com/items/115538/fbcomments"
    • shop

      The properties of the shop’s this Item belongs.

      • Required: yes
      • id

        The id of the shop this Item belong.

        • Required: yes
        • Type: string
        • Example: "lozoodisimona"
      • url

        The URL to fetch the details of the Shop to which this Item belong.

        • Required: yes
        • Type: string
        • Format: uri
        • Example: "https://api.blomming.com/v1/shops/lozoodisimona"
      • name

        The name of the shop.

        • Required: yes
        • Type: string
        • Example: "Lo Zoo di Simona"
      • image

        The logo of the shop

        • Required: yes
        • Type: uri
        • Format: uri
        • Example: "http://yourdomain.com/path/to/a/photo"
      • items_url

        the url of the Items sold by this shop.

        • Required: yes
        • Type: string
        • Format: uri
        • Example: "http://example.org/shops/lozoodisimona/items"
    • currency

      The currency in which the prices are exposed.

      • Required: yes
      • Type: string
      • Example: "EUR"

Response Codes

Successful Response Codes

Failure Response Codes