Comment on page
List all prices

How to fetch a collection of prices via API
To fetch a collection of prices, send a GET request to the /api/prices endpoint.
Request
GET https://yourdomain.commercelayer.io/api/prices
Example
Request
Response
The following request fetches a collection of prices:
curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/prices/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:
{
  "data": [
    {
      "id": "xYZkjABcde",
      "type": "prices",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde"
      },
      "attributes": {
        "currency_code": "EUR",
        "sku_code": "TSHIRTMM000000FFFFFFXLXX",
        "amount_cents": 10000,
        "amount_float": 100.0,
        "formatted_amount": "€100,00",
        "compare_at_amount_cents": 13000,
        "compare_at_amount_float": 130.0,
        "formatted_compare_at_amount": "€130,00",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANY-EXTERNAL-REFEFERNCE",
        "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "price_list": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/price_list",
            "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/price_list"
          }
        },
        "sku": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/sku",
            "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/sku"
          }
        },
        "price_tiers": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/price_tiers",
            "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/price_tiers"
          }
        },
        "price_volume_tiers": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/price_volume_tiers",
            "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/price_volume_tiers"
          }
        },
        "price_frequency_tiers": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/price_frequency_tiers",
            "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/price_frequency_tiers"
          }
        },
        "attachments": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/attachments",
            "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/attachments"
          }
        },
        "versions": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/relationships/versions",
            "related": "https://yourdomain.commercelayer.io/api/prices/xYZkjABcde/versions"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 9 prices (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/prices?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/prices?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/prices?page[number]=14&page[size]=10"
  }
}
Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of prices can be sorted by the following fields:
currency_code
amount_cents
compare_at_amount_cents
id
created_at
updated_at
reference
reference_origin
Filterable fields
The list of prices can be filtered by the following fields:
Attributes
currency_code
amount_cents
compare_at_amount_cents
id
created_at
updated_at
reference
reference_origin
metadata
Relationships
price_list
sku
price_tiers
attachments
Create a price
Retrieve a price
Last modified 1mo ago