Get a product group with its packaging

GET

/product-groups/{group_id}

curl --request GET \
  --url 'https://api.europlaybook.com/v1/product-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?history=false' \
  --header 'Authorization: Bearer <token>'

• Production

The group, its members (with the layers they override) and its packaging tree on on.

Authorizations

• BearerTokenAuth

Parameters

Path Parameters

group_id

required

Group Id

string format: uuid

Query Parameters

on

Any of:

string

string format: date

null

null

history

History

boolean

Responses

200

OK

Media typeapplication/json

ProductGroupDetailOut

object

id

required

Id

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

string format: date-time

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

members

required

Members

Array<object>

GroupMemberOut

object

id

required

Id

string format: uuid

sku

required

Sku

string

title

required

Title

string

own_layers

required

Own Layers

Layers on which the member has its own lines today (it does not inherit those).

Array<string>

packaging

required

GroupPackagingOut

The group’s own lines: every member’s default.

object

on

required

On

The day the totals are for.

string format: date

layers

required

Layers

Array<object>

PackagingLayerOut

object

layer

required

Layer

Sales (primary), grouped (secondary) or transport (tertiary).

string

Allowed values: sales grouped transport

lines

required

Lines

Array<object>

PackagingLineOut

One packaging line: quantity parts of item per sales unit, valid over a date range.

object

id

required

Id

string format: uuid

state

required

State

Proposed = not yet checked by a person; confirmed = part of a gate-1 confirmation.

string

Allowed values: proposed confirmed

quantity

required

Quantity

Parts per sales unit (may be a fraction, e.g. 1 film per 1440).

string

household

required

Household

Ends up with households (counts as household packaging).

boolean

scope_channel

Any of:

string

string

null

null

scope_fulfilment

Any of:

string

string

null

null

valid_from

Any of:

string

string format: date

null

null

valid_to

Any of:

string

string format: date

null

null

mass_mg

required

Mass Mg

Packaging mass per sales unit for this line (item mass x quantity).

integer

in_totals

required

In Totals

Counted in totals_by_material: valid on on and not limited to a channel/fulfilment.

boolean

source

required

Source

Where the line came from (provenance).

string

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

source_ref

Source Ref

Which record of that source, e.g. api:token:<prefix>.

string

""

inherited

Inherited

The line is the product group’s: the product has no own line on that layer.

boolean

group_id

Any of:

string

string format: uuid

null

null

item

required

PackagingItemOut

object

id

required

Id

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

string

null

null

recyclability_grade

Any of:

string

string

null

null

custom_for_product_id

Any of:

string

string format: uuid

null

null

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

string format: date-time

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

mass_mg

required

Mass Mg

Mass per sales unit of this layer’s lines that count in the totals.

integer

totals_by_material

required

Totals By Material

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

integer

Example

{
  "id": "0199f5a2-7c1e-7b4a-9d0e-3f6c2a1b8e44",
  "name": "Green tea",
  "code": "TEA",
  "source": "manual",
  "source_ref": "",
  "packaging": {
    "layers": [
      {
        "layer": "sales",
        "lines": [
          {
            "id": "0199f5a2-7c1e-7b4a-9d0e-3f6c2a1b8e44",
            "state": "proposed",
            "quantity": "1.0000",
            "source": "manual",
            "source_ref": "",
            "inherited": false,
            "item": {
              "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
            }
          }
        ]
      }
    ],
    "totals_by_material": [
      {
        "material": "paper",
        "mass_mg": 12000
      }
    ]
  }
}

400

Bad Request

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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

401

Unauthorized

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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

403

Forbidden

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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

404

Not Found

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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

409

Conflict

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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

422

Unprocessable Content

Media typeapplication/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

object

key

additional properties

any

null

null

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

Media typeapplication/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

object

key

additional properties

any

null

null

Example

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