Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Product Book

Retrieve all product books for the company

Retrieves all product books for the authenticated company. Able to search by keywords in name or description.

get/v2/product_book

Query parameters

order_by'-created_at' | 'created_at' | '-name' | 'name'

The field in which the results are ordered by

keywordsstring

String to search product books with

limitinteger

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

starting_afterstring

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

ending_beforestring

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

Response

Retrieves all product books for the authenticated company. Able to search by keywords in name or description.

messagestring required
statusinteger required

Example response

{
  "data": {
    "items": [
      {
        "created_at": 1574181282399,
        "key": "co_a80cb515fe",
        "updated_at": 1574181282399
      }
    ]
  }
}