List all price lists

How to fetch a collection of price lists via API

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

Request

GET https://yourdomain.commercelayer.io/api/price_lists

Example

The following request fetches a collection of price lists:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/price_lists/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of price lists can be sorted by the following fields:

Attributes

  • name

  • code

  • currency_code

  • tax_included

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Filterable fields

The list of price lists can be filtered by the following fields:

Attributes

  • name

  • code

  • currency_code

  • tax_included

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • rules

  • metadata

Relationships

  • prices

  • price_list_schedulers

  • attachments

Last updated