Commerce Layer will be proud to sponsor the next JAMstack Conf in London — 09-10 July, 2019 🎉 Stay tuned!

API REFERENCE

Price Lists

Price lists determine the SKU prices and their currency within a market. Create more price lists if you need to manage international business models or B2B/B2C.

The price list object

A Price list object is returned as part of the response body of each successful create, list, retrieve or update API call. The following table contains the list of all its fields along with their type, description and example values.

Object fields:
name
string
The market's internal name
Example:
EU Price list
currency_code
string
The international 3-letter currency code as defined by the ISO 4217 standard.
Example:
EUR
tax_included
boolean
Indiceates if the associated prices include taxes.
Example:
true
id
integer
Unique identifier for the resource.
Example:
1234
created_at
datetime
Time at which the resource was created.
Example:
2018-01-01T12:00:00.000Z
updated_at
datetime
Time at which the resource was last updated.
Example:
2018-01-01T12:00:00.000Z
reference
string
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
relationship (1:N)
The associated prices.

Create a price list

To create a new price list, send a POST request to the /api/price_lists endpoint, passing the resource arguments in the request body. The following table contains the list of all the possible arguments, along with their type, description and examples values. All the arguments marked as required must be present in the request.

Arguments:
name
required
The market's internal name
Example:
EU Price list
currency_code
required
The international 3-letter currency code as defined by the ISO 4217 standard.
Example:
EUR
tax_included
optional, default is 'true'
Indiceates if the associated prices include taxes.
Example:
true
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
Example request:
POST /api/price_lists HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "price_lists",
    "attributes": {
      "name": "EU Price list",
      "currency_code": "EUR"
    }
  }
}
Example response:
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "price_lists",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/price_lists/1234"
    },
    "attributes": {
      "name": "EU Price list",
      "currency_code": "EUR",
      "tax_included": "true",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "prices": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/price_lists/1234/relationships/prices",
          "related": "https://your-brand.commercelayer.io/api/price_lists/1234/prices"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

List all price lists

To fetch a collection of price lists, send a GET request to the /api/price_lists endpoint.

Example request:
GET /api/price_lists HTTP/1.1
Accept: application/vnd.api+json
Example response:
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "1234",
      "type": "price_lists",
      "links": {
        "self": "https://your-brand.commercelayer.io/api/price_lists/1234"
      },
      "attributes": {
        "name": "EU Price list",
        "currency_code": "EUR",
        "tax_included": "true",
        "id": "1234",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANYREFEFERNCE",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "prices": {
          "links": {
            "self": "https://your-brand.commercelayer.io/api/price_lists/1234/relationships/prices",
            "related": "https://your-brand.commercelayer.io/api/price_lists/1234/prices"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 24 price_lists (first page)"
    }
  ],
  "meta": {
    "record_count": 125,
    "page_count": 5
  },
  "links": {
    "first": "/api/price_lists?page[number]=1&page[size]=25",
    "prev": "/api/price_lists?page[number]=2&page[size]=25",
    "next": "/api/price_lists?page[number]=4&page[size]=25",
    "last": "/api/price_lists?page[number]=5&page[size]=25"
  }
}
Available filters
id q currency_code reference ids created_at_from created_at_to updated_at_from updated_at_to
Sortable attributes
name currency_code id created_at updated_at reference

Retrieve a price list

To fetch a single price list, send a GET request to the /api/price_lists/{{id}} endpoint, where {{id}} is the id of the resource that you want to retrieve.

Example request:
GET /api/price_lists/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response:
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "price_lists",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/price_lists/1234"
    },
    "attributes": {
      "name": "EU Price list",
      "currency_code": "EUR",
      "tax_included": "true",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "prices": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/price_lists/1234/relationships/prices",
          "related": "https://your-brand.commercelayer.io/api/price_lists/1234/prices"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Update a price list

To update an existing price list, send a PATCH request to the /api/price_lists/{{id}} endpoint, where {{id}} is the id of the resource that you want to update. The following table contains the list of all the possible arguments that you can pass with the request body, along with their type, description and examples values. Please note that all arguments are optional.

Arguments:
name
optional
The market's internal name
Example:
EU Price list
currency_code
optional
The international 3-letter currency code as defined by the ISO 4217 standard.
Example:
EUR
tax_included
optional
Indiceates if the associated prices include taxes.
Example:
true
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
Example request:
PATCH /api/price_lists/1234 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "price_lists",
    "id": 1234,
    "attributes": {
      "name": "EU Price list"
    },
    "relationships": {
    }
  }
}
Example response:
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "price_lists",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/price_lists/1234"
    },
    "attributes": {
      "name": "EU Price list",
      "currency_code": "EUR",
      "tax_included": "true",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "prices": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/price_lists/1234/relationships/prices",
          "related": "https://your-brand.commercelayer.io/api/price_lists/1234/prices"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Delete a price list

To delete a price list, send a DELETE request to the /api/price_lists/{{id}} endpoint, where {{id}} is the id of the resource that you want to delete.

Example request:
DELETE /api/price_lists/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response:
HTTP/1.1 204 No Content