Create or update a product by SKU

PUT

/products/by-sku/{sku}

const url = 'https://api.europlaybook.com/v1/products/by-sku/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"gtin":"8712345678906","net_weight_mg":100000,"title":"Green tea 100 g"}'
};

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

curl --request PUT \
  --url https://api.europlaybook.com/v1/products/by-sku/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "gtin": "8712345678906", "net_weight_mg": 100000, "title": "Green tea 100 g" }'

Creates the product (201) or updates the fields you send (200). Product data only: packaging goes through proposals. Changing a product does not touch its packaging confirmation.

Authorizations

BearerTokenAuth

Parameters

Path Parameters

sku

required

Sku

string

Request Body^required

application/json

ProductUpsertIn

Create the product with this SKU, or update the fields you send. Fields you leave out stay as they are (on create they get their default).

object

title

required

Title

Product name.

string

>= 1 characters <= 300 characters

brand_name

Any of:

string
null

string

<= 200 characters

gtin

Any of:

string
null

string

<= 14 characters

hs_code

Any of:

string
null

string

<= 12 characters

country_of_origin

Any of:

string
null

string

<= 2 characters

net_weight_mg

Any of:

integer
null

integer

is_electrical

Any of:

boolean
null

boolean

is_textile

Any of:

boolean
null

boolean

Responses

200

application/json

ProductOut

object

required

string format: uuid

sku

required

Sku

Your stock keeping unit; unique per account.

string

title

required

Title

Product name.

string

brand_name

required

Brand Name

Brand on the product.

string

gtin

Any of:

string
null

string

hs_code

required

Hs Code

Customs tariff code.

string

country_of_origin

required

Country Of Origin

ISO 3166-1 alpha-2.

string

net_weight_mg

Any of:

integer
null

integer

status

required

Status

Archived products are kept for history.

string

Allowed values: active archived

is_kit

required

Is Kit

A bundle of other products (bill of materials).

boolean

is_electrical

required

Is Electrical

Electrical/electronic equipment (WEEE).

boolean

is_textile

required

Is Textile

Textile product (textiles EPR).

boolean

packaging_confirmed

required

Packaging Confirmed

Gate 1: a person confirmed this product’s packaging. Changing packaging (also through a proposal) clears it until someone confirms again in the portal.

boolean

confirmed_at

Any of:

string
null

string format: date-time

confirmation

required

ConfirmationOut

Gate 1 in detail (complements packaging_confirmed, which equals state confirmed when the packaging is unchanged).

object

state

required

State

None = never confirmed; confirmed = the packaging is what a person confirmed; changed = it was confirmed, but the packaging (own or inherited) differs now.

string

Allowed values: none confirmed changed

Any of:

string
null

string format: date-time

Any of:

string
null

string

group_id

Any of:

string
null

string format: uuid

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

Example

{
  "id": "0199f5a2-7c1e-7b4a-9d0e-3f6c2a1b8e44",
  "sku": "TEA-001",
  "title": "Green tea 100 g",
  "brand_name": "Demo Garden",
  "gtin": "8712345678906",
  "hs_code": "090210",
  "country_of_origin": "NL",
  "net_weight_mg": 100000,
  "status": "active",
  "confirmation": {
    "state": "none"
  }
}

201

Created

application/json

ProductOut

object

required

string format: uuid

sku

required

Sku

Your stock keeping unit; unique per account.

string

title

required

Title

Product name.

string

brand_name

required

Brand Name

Brand on the product.

string

gtin

Any of:

string
null

string

hs_code

required

Hs Code

Customs tariff code.

string

country_of_origin

required

Country Of Origin

ISO 3166-1 alpha-2.

string

net_weight_mg

Any of:

integer
null

integer

status

required

Status

Archived products are kept for history.

string

Allowed values: active archived

is_kit

required

Is Kit

A bundle of other products (bill of materials).

boolean

is_electrical

required

Is Electrical

Electrical/electronic equipment (WEEE).

boolean

is_textile

required

Is Textile

Textile product (textiles EPR).

boolean

packaging_confirmed

required

Packaging Confirmed

Gate 1: a person confirmed this product’s packaging. Changing packaging (also through a proposal) clears it until someone confirms again in the portal.

boolean

confirmed_at

Any of:

string
null

string format: date-time

confirmation

required

ConfirmationOut

Gate 1 in detail (complements packaging_confirmed, which equals state confirmed when the packaging is unchanged).

object

state

required

State

None = never confirmed; confirmed = the packaging is what a person confirmed; changed = it was confirmed, but the packaging (own or inherited) differs now.

string

Allowed values: none confirmed changed

Any of:

string
null

string format: date-time

Any of:

string
null

string

group_id

Any of:

string
null

string format: uuid

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

Example

{
  "id": "0199f5a2-7c1e-7b4a-9d0e-3f6c2a1b8e44",
  "sku": "TEA-001",
  "title": "Green tea 100 g",
  "brand_name": "Demo Garden",
  "gtin": "8712345678906",
  "hs_code": "090210",
  "country_of_origin": "NL",
  "net_weight_mg": 100000,
  "status": "active",
  "confirmation": {
    "state": "none"
  }
}

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"
  }
}

Create or update a product by SKU

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Example

201

Example

400

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

Request Body^required