List packaging items

GET

/packaging-items

const url = 'https://api.europlaybook.com/v1/packaging-items?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/packaging-items?limit=50&archived=hide' \
  --header 'Authorization: Bearer <token>'

The packaging library: reusable parts (boxes, bags, fillers) with their material breakdown. Parts made for one product only are not listed (they appear in that product’s packaging tree).

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

archived

Archived

string

default: hide

Responses

200

application/json

PackagingItemPage

object

items

required

Items

Array<object>

PackagingItemOut

object

required

string format: uuid

name

required

Name

Name of the packaging part.

string

code

required

Code

Your code for the part (unique per account when set).

string

role_default

required

Role Default

Usual role: sales, grouped, transport, shipping or filler.

string

household_default

required

Household Default

Usually ends up with households (vs. businesses).

boolean

separable

required

Separable

Can be separated from the other parts by hand.

boolean

rigidity

required

Rigidity

string

Allowed values: rigid flexible

recycled_content_pct

Any of:

string
null

string

recyclability_grade

Any of:

string
null

string

custom_for_product_id

Any of:

string
null

string format: uuid

materials

required

Materials

Material breakdown of ONE part.

Array<object>

MaterialMassOut

object

material

required

Material

Material code from the knowledge pack (see /reference/materials).

string

mass_mg

required

Mass Mg

Mass in milligrams.

integer

total_mass_mg

required

Total Mass Mg

Sum of the materials, milligrams.

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": "Folding box S",
      "code": "BOX-S",
      "rigidity": "rigid",
      "materials": [
        {
          "material": "paper",
          "mass_mg": 12000
        }
      ],
      "total_mass_mg": 12500
    }
  ],
  "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"
  }
}