Get all Price Books

GET 
/pcm/pricebooks

Retrieves a list of all price books.

Filtering

Filtering is supported on this endpoint. For the general syntax, see Filtering.

You can filter on the following attributes and operators.

Operator	Attribute	Description	Example
eq	external_ref	Equals. Checks if the values you provide matches a price book.	filter=eq(external_ref,some-external-ref)

Request

Query Parameters

filter string

You can filter on this endpoint. See Filtering.

page[limit] int64

Possible values: >= 1

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the page length store setting is used.

page[offset] int64

Possible values: <= 10000

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page offset is set, the page length store setting is used.

Responses

200

The list of price books.

application/json

Schema

Schema

meta object

Contains the results for the entire collection.

results object

total integernullable

Total number of results for the entire collection.

page object

limit integer

The maximum number of records for all pages.

offset integer

The current offset by number of pages.

current integer

The current number of pages.

total integer

The total number of records for the entire collection.

data object[]required
Array [
id stringrequired
A unique identifier of a price book.
type stringrequired
Possible values: [pricebook]
Default value: pricebook
Always pricebook.
attributes objectrequired
external_ref stringnullable
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
description stringnullable
A brief description that outlines the purpose of a price book, for example, flash sale pricing or preferred customer pricing.
name stringnullablerequired
The name of a price book. Price books must have a unique name
created_at date-timerequired
The date and time when the price book was created.
updated_at date-timerequired
The date and time when the price book was last updated.
meta object
owner stringnullable
The resource owner, either organization or store.
]
links object

Links are used to allow you to move between requests. Single entities use a self parameter with a link to that specific resource. Sometimes, there aren’t enough entities for a project to fill multiple pages. In this situation, we return some defaults, instead of expecting you to check for these special cases.

self urinullable

Single entities use a self parameter with a link to that specific resource.

first urinullable

Always the first page.

last urinullable

This is null if there is only one page.

prev urinullable

This is null if there is only one page.

next urinullable

This is null if there is only one page.

Example (from schema)

{
  "meta": {
    "results": {
      "total": 1
    },
    "page": {
      "limit": 10,
      "offset": 0,
      "current": 0,
      "total": 1
    }
  },
  "data": [
    {
      "id": "4c45e4ec-26e0-4043-86e4-c15b9cf985a7",
      "type": "pricebook",
      "attributes": {
        "external_ref": "an-external-ref",
        "description": "This is a test price book",
        "name": "Standard Price Book",
        "created_at": "2020-09-22T09:00:00Z",
        "updated_at": "2020-09-22T09:00:00Z"
      },
      "meta": {
        "owner": "store"
      }
    }
  ],
  "links": {
    "self": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7?filter=like(name,*Standard*)",
    "first": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7?filter=like(name,*Standard*)&page[offset]=0&page[limit]=25",
    "last": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7?filter=like(name,*Standard*)&page[offset]=0&page[limit]=25",
    "prev": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7?filter=like(name,*Standard*)&page[offset]=0&page[limit]=25",
    "next": "/pcm/pricebooks/4c45e4ec-26e0-4043-86e4-c15b9cf985a7?filter=like(name,*Standard*)&page[offset]=25&page[limit]=25"
  }
}

default

Unexpected error.

application/json

Schema

Schema

errors object[]
Array [
detail string
status string
title string
]

Example (from schema)

{
  "errors": [
    {
      "detail": "The price book already exists",
      "status": "409",
      "title": "conflict"
    }
  ]
}

Loading...