List product groups

GET

/product-groups

const url = 'https://api.europlaybook.com/v1/product-groups?limit=50&archived=hide';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.europlaybook.com/v1/product-groups?limit=50&archived=hide' \
  --header 'Authorization: Bearer <token>'

Groups of products that share packaging, by name. A member inherits the group’s lines per layer unless it has its own lines on that layer.

Authorizations

BearerTokenAuth

Parameters

Query Parameters

cursor

Any of:

string
null

string

Opaque cursor from next_cursor of the previous page.

limit

Limit

Items per page (1-200).

integer

default: 50 >= 1 <= 200

Items per page (1-200).

Any of:

string
null

string

Search in name, code and member SKUs.

archived

Archived

As for products.

string

default: hide

Allowed values: hide only all

As for products.

Responses

200

application/json

ProductGroupPage

object

items

required

Items

Array<object>

ProductGroupOut

Products that share packaging (e.g. the variants of one Shopify product).

object

required

string format: uuid

name

required

Name

string

code

required

Code

Unique per account: a Shopify product gid or a SKU stem.

string

source

required

Source

string

Allowed values: manual csv odoo shopify picqer supplier_spec photo api ai

source_ref

Source Ref

string

member_count

required

Member Count

Products in the group.

integer

packaging_count

required

Packaging Count

Packaging lines of the group (all versions).

integer

archived_at

Any of:

string
null

string format: date-time

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

next_cursor

Any of:

string
null

string

Example

{
  "items": [
    {
      "id": "0199f5a2-7c1e-7b4a-9d0e-3f6c2a1b8e44",
      "name": "Green tea",
      "code": "TEA",
      "source": "manual",
      "source_ref": ""
    }
  ],
  "next_cursor": "WyIwMTk5ZjVhMi03YzFlLTdiNGEtOWQwZS0zZjZjMmExYjhlNDQiXQ"
}

400

Bad Request

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

401

Unauthorized

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

403

Forbidden

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

404

Not Found

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

409

Conflict

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}

422

Unprocessable Content

application/json

PublicValidationErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

errors

Errors

Per-field problems (pydantic format: loc, msg, type).

Array<object>

default:

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  },
  "errors": []
}

429

Too Many Requests

application/json

PublicErrorOut

object

detail

required

Detail

What went wrong, in English, for people and logs.

string

code

required

Code

Stable machine-readable error code; translate and branch on this.

string

params

Any of:

object
null

object

key

additional properties

any

Example

{
  "detail": "This API key lacks the scope catalogue:write",
  "code": "insufficient_scope",
  "params": {
    "required_scope": "catalogue:write"
  }
}