PSI Backend API (2.0.0)

Postman collection → OpenAPI spec →

Introduction

This is the PSI Backend API Documentation.

Base URL: https://api.psiproductfinder.de

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_BEARER_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Authentication

Authenticate

POST

https://api.psiproductfinder.de

/v2/auth

This endpoint allows you to authenticate and retrieve an access_token and a refresh_token. The access_token must be included in the header of every API request to access protected resources. You can log in using your standard PSI account credentials. However, to avoid potential issues caused by password changes of regular user accounts, we strongly recommend creating a dedicated Sub-Account for API access. You can set up a Sub-Account in your PSI account settings (https://www.psi-network.de/).

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

username

string

required

Your Username - is the same as you login to other PSI Services (Productfinder, Network..), can be an E-Mail Adress or the PSI-Number.

Example:

demo@psi-network.de

password

string

required

Your Password.

Example:

password

Headers

Body

{ "username": "demo@psi-network.de", "password": "password" }

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/auth" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"demo@psi-network.de\",
    \"password\": \"password\"
}"

Example response:

{
    "access_token": "eyJ0eXAidemoV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJwcLmRlIiwiYXVkIjoicHNpcHJvZHVjdansmRlci5kZSIsImp0adIeoQzNjMwIiwiaWF0IjoxNzM3MDE5NTQ2LjE2OTkyMiwibmJmIjoxNzM3MDE5NTQ2LjE2OTkyMiwiZXhwIjoxNzM3MDE5NTQ2LjE2OTkyMiwicGF5bG9hZCI6eyJwc2lubyI6NDM2MzAsInVzZXJfaWQiOjEyNDcyOSwiZ3JvdXBzIjoiMTQiLCJlbWFpbCI6ImZyYW5rQHJoZWluc2NoYWZlLmRlIn19",
    "refresh_token": "07070512341eacdemo3a64267c377cdcf06501",
    "expires_in": 1737019546
}

Refresh Token

POST

https://api.psiproductfinder.de

/v2/refresh

Your access_token is valid for the duration specified in the expires_in field of the authentication response (e.g., typically 1 hour). Once the token expires, you must generate a new one to continue accessing protected resources.

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

username

string

required

Your E-Mail Adress or the PSI-Number, at the moment you can not use a sub account here.

Example:

demo@psi-network.de

refresh_token

string

required

Your refresh token.

Example:

07070512341eacdemo3a64267c377cdcf06501

Headers

Body

{ "username": "demo@psi-network.de", "refresh_token": "07070512341eacdemo3a64267c377cdcf06501" }

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"demo@psi-network.de\",
    \"refresh_token\": \"07070512341eacdemo3a64267c377cdcf06501\"
}"

Example response:

{
    "access_token": "eyJ0eXAidemoV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJwcLmRlIiwiYXVkIjoicHNpcHJvZHVjdansmRlci5kZSIsImp0adIeoQzNjMwIiwiaWF0IjoxNzM3MDE5NTQ2LjE2OTkyMiwibmJmIjoxNzM3MDE5NTQ2LjE2OTkyMiwiZXhwIjoxNzM3MDE5NTQ2LjE2OTkyMiwicGF5bG9hZCI6eyJwc2lubyI6NDM2MzAsInVzZXJfaWQiOjEyNDcyOSwiZ3JvdXBzIjoiMTQiLCJlbWFpbCI6ImZyYW5rQHJoZWluc2NoYWZlLmRlIn19",
    "expires_in": 1737020073
}

Product Controller

Get Entities

GET

https://api.psiproductfinder.de

/v2/products

requires authentication

The Get Entities endpoint allows you to retrieve all products associated with your PSI number. It returns all products that belong to your account, but you can customize the results using optional query parameters.

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

language

string

Must be one of:

de
en

Example:

locale

string

Must be one of:

de
en

Example:

filter

string

Example:

outdated

string

Example:

Suchen

page

number

Must be at least 1.

Example:

size

number

Must be at least 1. Must not be greater than 100.

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.psiproductfinder.de/v2/products?language=en&locale=en&filter=outdated&search=Suchen&page=1&size=24" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "code": 200,
    "status": "OK",
    "data": [],
    "meta": {}
}

Create Entity

POST

https://api.psiproductfinder.de

/v2/products/store

requires authentication

To create a variant or translation, simply post a payload containing the required parameters. If you specify a language other than the default (en), a new translation for the specified language will be added.

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

The name of the entity.

Example:

Demo Product

product_number

string

required

The product_number.

Example:

demo-001

language

enum

Must be one of:

de
en

Example:

locale

enum

Must be one of:

de
en

Example:

master_product_number

string

The master product number for creating a variant

Example:

demo-001

brand

string

Example:

PSI-Demo

description

string

Example:

This is just a demo product

tags

string

Example:

demo1, demo2

ean_code

string

Example:

1234567890

product_groups

string[]

Items Enum number of the PSI productgroup value

Example:

["05138008","08094001"]

certificates

string[]

Items Enum of the PSI certificate code value

Example:

["CERT-04200000"]

colors

string[]

Items Enum of the PSI color groups value

Example:

["CG-BLAK5"]

color_description

string

Example:

red

country_origin

string

Item Enum of the PSI countries value

Example:

CC-DE

made_in

string

Item Enum of the PSI countries value

Example:

CC-DE

images

string[]

Example:

[{"src":"https:\/\/psiproductfinder.de\/images\/logo\/logo.svg","name":"Demo logo image","description":"Custom description"}]

delivery_time_max

integer

Example:

delivery_time_min

integer

Example:

finishings

string[]

Items Enum of the PSI finishing groups.
included is for this finishing method is included in the product's price.

Example:

[{"group":"FG-APPN11","included":true,"description":"Demo application"}]

finishings_information

string

Example:

Finishing information

legal_information

string

Example:

Legal information

material_description

string

Example:

Material description

materials

string[]

Items Enum of the PSI materials groups

Example:

["MG-ACRC7"]

measurement_length

integer

Example:

100

measurement_volume

integer

Example:

measurement_height

integer

Example:

150

measurement_width

integer

Example:

135

measurement_information

string

Example:

Measurement information

weight_netto

integer

Example:

weight_brutto

integer

Example:

minimum_order_amount

integer

Example:

packaging

integer

Example:

price_ranges

string[]

Example:

[{"amount":1,"price_ek":1.5,"price_uvp":2},{"amount":5,"price_ek":1,"price_uvp":1.5}]

price_ranges_information

string

Example:

Price ranges information

product_information

string

Example:

Product information

stock_available

boolean

Is this product is always in stock?

Example:

true

delivery_information

string

Example:

Delivery information

target_group

string

Example:

Target group

video

string

Example:

https://www.youtube.com/watch?v=pCHJAj5oPu0

Auth

Bearer

Headers

Body

{ "name": "Demo Product", "product_number": "demo-001", "language": "en", "locale": "en", "master_product_number": "demo-001", "brand": "PSI-Demo", "description": "This is just a demo product", "tags": "demo1, demo2", "ean_code": "1234567890", "product_groups": [ "05138008", "08094001" ], "certificates": [ "CERT-04200000" ], "colors": [ "CG-BLAK5" ], "color_description": "red", "country_origin": "CC-DE", "made_in": "CC-DE", "images": [ { "src": "https:\/\/psiproductfinder.de\/images\/logo\/logo.svg", "name": "Demo logo image", "description": "Custom description" } ], "delivery_time_max": 3, "delivery_time_min": 1, "finishings": [ { "group": "FG-APPN11", "included": true, "description": "Demo application" } ], "finishings_information": "Finishing information", "legal_information": "Legal information", "material_description": "Material description", "materials": [ "MG-ACRC7" ], "measurement_length": 100, "measurement_volume": 10, "measurement_height": 150, "measurement_width": 135, "measurement_information": "Measurement information", "weight_netto": 10, "weight_brutto": 13, "minimum_order_amount": 1, "packaging": 2, "price_ranges": [ { "amount": 1, "price_ek": 1.5, "price_uvp": 2 }, { "amount": 5, "price_ek": 1, "price_uvp": 1.5 } ], "price_ranges_information": "Price ranges information", "product_information": "Product information", "stock_available": true, "delivery_information": "Delivery information", "target_group": "Target group", "video": "https:\/\/www.youtube.com\/watch?v=pCHJAj5oPu0" }

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/products/store" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Demo Product\",
    \"product_number\": \"demo-001\",
    \"language\": \"en\",
    \"locale\": \"en\",
    \"master_product_number\": \"demo-001\",
    \"brand\": \"PSI-Demo\",
    \"description\": \"This is just a demo product\",
    \"tags\": \"demo1, demo2\",
    \"ean_code\": \"1234567890\",
    \"product_groups\": [
        \"05138008\",
        \"08094001\"
    ],
    \"certificates\": [
        \"CERT-04200000\"
    ],
    \"colors\": [
        \"CG-BLAK5\"
    ],
    \"color_description\": \"red\",
    \"country_origin\": \"CC-DE\",
    \"made_in\": \"CC-DE\",
    \"images\": [
        {
            \"src\": \"https:\\/\\/psiproductfinder.de\\/images\\/logo\\/logo.svg\",
            \"name\": \"Demo logo image\",
            \"description\": \"Custom description\"
        }
    ],
    \"delivery_time_max\": 3,
    \"delivery_time_min\": 1,
    \"finishings\": [
        {
            \"group\": \"FG-APPN11\",
            \"included\": true,
            \"description\": \"Demo application\"
        }
    ],
    \"finishings_information\": \"Finishing information\",
    \"legal_information\": \"Legal information\",
    \"material_description\": \"Material description\",
    \"materials\": [
        \"MG-ACRC7\"
    ],
    \"measurement_length\": 100,
    \"measurement_volume\": 10,
    \"measurement_height\": 150,
    \"measurement_width\": 135,
    \"measurement_information\": \"Measurement information\",
    \"weight_netto\": 10,
    \"weight_brutto\": 13,
    \"minimum_order_amount\": 1,
    \"packaging\": 2,
    \"price_ranges\": [
        {
            \"amount\": 1,
            \"price_ek\": 1.5,
            \"price_uvp\": 2
        },
        {
            \"amount\": 5,
            \"price_ek\": 1,
            \"price_uvp\": 1.5
        }
    ],
    \"price_ranges_information\": \"Price ranges information\",
    \"product_information\": \"Product information\",
    \"stock_available\": true,
    \"delivery_information\": \"Delivery information\",
    \"target_group\": \"Target group\",
    \"video\": \"https:\\/\\/www.youtube.com\\/watch?v=pCHJAj5oPu0\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.psiproductfinder.de/v2/products/store';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_BEARER_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => \Symfony\Component\VarExporter\Internal\Hydrator::hydrate(
            $o = [
                clone (($p = &\Symfony\Component\VarExporter\Internal\Registry::$prototypes)['stdClass'] ?? \Symfony\Component\VarExporter\Internal\Registry::p('stdClass')),
                clone $p['stdClass'],
                clone $p['stdClass'],
                clone $p['stdClass'],
            ],
            null,
            [
                'stdClass' => [
                    'src' => [
                        'https://psiproductfinder.de/images/logo/logo.svg',
                    ],
                    'name' => [
                        'Demo logo image',
                    ],
                    'description' => [
                        'Custom description',
                        'Demo application',
                    ],
                    'group' => [
                        1 => 'FG-APPN11',
                    ],
                    'included' => [
                        1 => true,
                    ],
                    'amount' => [
                        2 => 1,
                        5,
                    ],
                    'price_ek' => [
                        2 => 1.5,
                        1,
                    ],
                    'price_uvp' => [
                        2 => 2,
                        1.5,
                    ],
                ],
            ],
            [
                'name' => 'Demo Product',
                'product_number' => 'demo-001',
                'language' => 'en',
                'locale' => 'en',
                'master_product_number' => 'demo-001',
                'brand' => 'PSI-Demo',
                'description' => 'This is just a demo product',
                'tags' => 'demo1, demo2',
                'ean_code' => '1234567890',
                'product_groups' => [
                    '05138008',
                    '08094001',
                ],
                'certificates' => [
                    'CERT-04200000',
                ],
                'colors' => [
                    'CG-BLAK5',
                ],
                'color_description' => 'red',
                'country_origin' => 'CC-DE',
                'made_in' => 'CC-DE',
                'images' => [
                    $o[0],
                ],
                'delivery_time_max' => 3,
                'delivery_time_min' => 1,
                'finishings' => [
                    $o[1],
                ],
                'finishings_information' => 'Finishing information',
                'legal_information' => 'Legal information',
                'material_description' => 'Material description',
                'materials' => [
                    'MG-ACRC7',
                ],
                'measurement_length' => 100,
                'measurement_volume' => 10,
                'measurement_height' => 150,
                'measurement_width' => 135,
                'measurement_information' => 'Measurement information',
                'weight_netto' => 10,
                'weight_brutto' => 13,
                'minimum_order_amount' => 1,
                'packaging' => 2,
                'price_ranges' => [
                    $o[2],
                    $o[3],
                ],
                'price_ranges_information' => 'Price ranges information',
                'product_information' => 'Product information',
                'stock_available' => true,
                'delivery_information' => 'Delivery information',
                'target_group' => 'Target group',
                'video' => 'https://www.youtube.com/watch?v=pCHJAj5oPu0',
            ],
            []
        ),
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://api.psiproductfinder.de/v2/products/store"
);

const headers = {
    "Authorization": "Bearer {YOUR_BEARER_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Demo Product",
    "product_number": "demo-001",
    "language": "en",
    "locale": "en",
    "master_product_number": "demo-001",
    "brand": "PSI-Demo",
    "description": "This is just a demo product",
    "tags": "demo1, demo2",
    "ean_code": "1234567890",
    "product_groups": [
        "05138008",
        "08094001"
    ],
    "certificates": [
        "CERT-04200000"
    ],
    "colors": [
        "CG-BLAK5"
    ],
    "color_description": "red",
    "country_origin": "CC-DE",
    "made_in": "CC-DE",
    "images": [
        {
            "src": "https:\/\/psiproductfinder.de\/images\/logo\/logo.svg",
            "name": "Demo logo image",
            "description": "Custom description"
        }
    ],
    "delivery_time_max": 3,
    "delivery_time_min": 1,
    "finishings": [
        {
            "group": "FG-APPN11",
            "included": true,
            "description": "Demo application"
        }
    ],
    "finishings_information": "Finishing information",
    "legal_information": "Legal information",
    "material_description": "Material description",
    "materials": [
        "MG-ACRC7"
    ],
    "measurement_length": 100,
    "measurement_volume": 10,
    "measurement_height": 150,
    "measurement_width": 135,
    "measurement_information": "Measurement information",
    "weight_netto": 10,
    "weight_brutto": 13,
    "minimum_order_amount": 1,
    "packaging": 2,
    "price_ranges": [
        {
            "amount": 1,
            "price_ek": 1.5,
            "price_uvp": 2
        },
        {
            "amount": 5,
            "price_ek": 1,
            "price_uvp": 1.5
        }
    ],
    "price_ranges_information": "Price ranges information",
    "product_information": "Product information",
    "stock_available": true,
    "delivery_information": "Delivery information",
    "target_group": "Target group",
    "video": "https:\/\/www.youtube.com\/watch?v=pCHJAj5oPu0"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response:

{
    "code": 200,
    "status": "OK",
    "message": "Product with identifier 'v-1b93b0c9' has been successfully created.",
    "data": {
        "product_id": "9df97825-f13f-44b0-a20f-126b463d25eb",
        "product_identifier": "p-9a33ae89",
        "selected_identifier": "v-1b93b0c9",
        "variant_id": "9df97825-f2c2-43ea-9f3d-e2b3c8a1ebf5",
        "variant_identifier": "v-1b93b0c9",
        "master_article_number": "43630S31463938362D64424946456578573178",
        "master_product_number": "1F986-dBIFEexW1x",
        "available_translations": [
            "en"
        ],
        "brand": null,
        "certificates": [],
        "color_description": null,
        "colors": [],
        "country_origin": null,
        "delivery_information": null,
        "delivery_time_max": null,
        "delivery_time_min": null,
        "description": null,
        "ean_code": null,
        "finishings_information": null,
        "finishings": [],
        "images": [],
        "legal_information": null,
        "made_in": null,
        "material_description": null,
        "materials": [],
        "measurement_height": null,
        "measurement_information": null,
        "measurement_length": null,
        "measurement_volume": null,
        "measurement_width": null,
        "minimum_order_amount": null,
        "name": "Demo Product",
        "packaging": null,
        "price_ranges_information": null,
        "price_ranges": [],
        "product_groups": [],
        "product_information": null,
        "product_number": "demo-001",
        "stock_available": false,
        "tags": null,
        "target_group": null,
        "video": null,
        "weight_brutto": null,
        "weight_netto": null
    }
}

Get Entity

GET

https://api.psiproductfinder.de

/v2/products/{identifier}

requires authentication

This endpoint is used to retrieve a specific product or variant. You can identify the entity using one of the following methods: Internal Identifier: A unique identifier generated from your master_product_number, PSI number, and product_number. Identifiers starting with p- refer to a master product, and identifiers starting with v- refer to a variant. Product Number: You can also use your custom product_number as an identifier. Note: If you request a master product (p-), the response will include all associated variants.

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

identifier

string

required.

Example:

p-c2a1cf5x

Query Parameters

language

string

Must be one of:

de
en

Example:

locale

string

Must be one of:

de
en

Example:

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.psiproductfinder.de/v2/products/p-c2a1cf5x?language=en&locale=en" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "code": 400,
    "status": "Bad request"
}

Update Entity

PATCH

https://api.psiproductfinder.de

/v2/products/update/{identifier}

requires authentication

To update variants and translations, you need to specify the variant_identifier (e.g., v-88c62663). For updating a translation, you must also include the language parameter.
All parameters available in the "Create Entity" endpoint can also be used when updating an entity, allowing for flexible modifications.

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

identifier

string

Example:

v-88c62663

Body Parameters

name

string

The name of the entity.

Example:

Demo Product updated

language

enum

Must be one of:

de
en

Example:

locale

enum

Must be one of:

de
en

Example:

description

string

Example:

This is just a demo product - updated

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Demo Product updated", "language": "en", "locale": "en", "description": "This is just a demo product - updated" }

Received response

Example request:

curl --request PATCH \
    "https://api.psiproductfinder.de/v2/products/update/v-88c62663" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Demo Product updated\",
    \"language\": \"en\",
    \"locale\": \"en\",
    \"description\": \"This is just a demo product - updated\"
}"

Example response:

{
    "code": 200,
    "status": "OK",
    "message": "Product with identifier 'v-88c62663' has been successfully updated.",
    "data": {
        "product_id": "9dfb33f7-03b7-4598-9178-9799e3710560",
        "product_identifier": "p-76ca02e6",
        "selected_identifier": "v-88c62663",
        "variant_id": "9dfb33f7-061d-4737-93fb-71e62bc9b25d",
        "variant_identifier": "v-88c62663",
        "master_article_number": "43630S64656D6F2D303031",
        "master_product_number": "1F43C-UQlQJ9yMwQ",
        "available_translations": [
            "en"
        ],
        "brand": "PSI-Demo",
        "certificates": [
            {
                "group": "CERT-04200000",
                "label": "Fair for life"
            }
        ],
        "color_description": "red",
        "colors": [
            {
                "group": "CG-BLAK5",
                "label": "Black"
            }
        ],
        "country_origin": null,
        "delivery_information": "Delivery information",
        "delivery_time_max": 3,
        "delivery_time_min": 1,
        "description": "This is just a demo product - updated",
        "ean_code": "1234567890",
        "finishings_information": "Finishing information",
        "finishings": [
            {
                "group": "FG-APPN11",
                "label": "Application",
                "description": "Demo application",
                "included": true
            }
        ],
        "images": [
            {
                "src": "https://psiproductfinder.de/images/logo/logo.svg",
                "name": "Demo logo image",
                "description": "Custom description"
            },
            {
                "src": null,
                "name": null,
                "description": null
            }
        ],
        "legal_information": "Legal information",
        "made_in": null,
        "material_description": "Material description",
        "materials": [
            {
                "group": "MG-ACRC7",
                "label": "Acrylic"
            }
        ],
        "measurement_height": 150,
        "measurement_information": "Measurement information",
        "measurement_length": 100,
        "measurement_volume": "10.00",
        "measurement_width": 135,
        "minimum_order_amount": 1,
        "name": "Demo Product updated",
        "packaging": 2,
        "price_ranges_information": "Price ranges information",
        "price_ranges": [
            {
                "amount": 1,
                "price_ek": 1.5,
                "price_uvp": 2
            },
            {
                "amount": 5,
                "price_ek": 1,
                "price_uvp": 1.5
            }
        ],
        "product_groups": [
            {
                "label": "Kitchen Items > Slicer",
                "group": "05138008"
            },
            {
                "label": "Beverages > Beer",
                "group": "08094001"
            }
        ],
        "product_information": "Product information",
        "product_number": "demo-001",
        "stock_available": true,
        "tags": "demo1, demo2",
        "target_group": "Target group",
        "video": "https://www.youtube.com/watch?v=pCHJAj5oPu0",
        "weight_brutto": 13,
        "weight_netto": 10
    }
}

Delete Entity

DELETE

https://api.psiproductfinder.de

/v2/products/delete/{identifier}

requires authentication

To delete a variant, translation, or product, you need to provide the identifier (e.g., p-88c62663 for a product or v-88c62663 for a variant). If you want to delete a translation in a language other than the default (English), you must also specify the language parameter.

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

identifier

string

Example:

v-88c62663

Body Parameters

language

enum

Must be one of:

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "language": "en" }

Received response

Example request:

curl --request DELETE \
    "https://api.psiproductfinder.de/v2/products/delete/v-88c62663" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"language\": \"en\"
}"

Example response:

{
    "code": 200,
    "status": "success",
    "message": "Product with identifier ':identifier' has been successfully deleted."
}

Image Controller

Receive Identifier

GET

https://api.psiproductfinder.de

/v2/upload-identifier

requires authentication

To upload an image, the system requires a unique identifier for each image, which acts like an access token for the upload process. First, call the dedicated endpoint to generate the identifier. Once you have the identifier, use it to upload the image through the upload endpoint.

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.psiproductfinder.de/v2/upload-identifier" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "identifier": "57842050-b8be-4a0a-9383-130b0fa4d84e"
}

Upload Image

POST

https://api.psiproductfinder.de

/v2/upload-image

requires authentication

To upload images directly to the Productfinder, use a multipart form upload. Each image requires a unique identifier, which can be obtained by calling the respective endpoint beforehand. Once the images are uploaded, the returned URLs can be used as image URLs and assigned to variants.

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

bookmark

boolean

Example:

false

identifier

string

Example:

57842050-demo-4a0a-9383-130b0fa4d84e

image

file

required

Must be an image.

Example:

/tmp/phpC4v5Gp

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/upload-image" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "bookmark="\
    --form "identifier=57842050-demo-4a0a-9383-130b0fa4d84e"\
    --form "image=@/tmp/phpC4v5Gp"

Example response:

{
    "filename": "42d0050d623c8ec4481539245c1e6de9.png",
    "absolute": "https://media.psiproductfinder.de/images/43630/42d0050d623c8ec4481539245c1e6de9.png"
}

Endpoints

POST v2/bookmarks/{bookmarkId}/contact

POST

https://api.psiproductfinder.de

/v2/bookmarks/{bookmarkId}/contact

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

bookmarkId

string

required

Example:

deserunt

Body Parameters

identifier

string

Example:

officiis

Auth

Bearer

Headers

URL Parameters

Body

{ "identifier": "officiis" }

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/bookmarks/deserunt/contact" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"identifier\": \"officiis\"
}"

POST v2/products/translation

POST

https://api.psiproductfinder.de

/v2/products/translation

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/products/translation" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET v2/user-histories

GET

https://api.psiproductfinder.de

/v2/user-histories

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Must be at least 1 character.

Example:

fay.velda@example.com

Auth

Bearer

Headers

Body

{ "email": "fay.velda@example.com" }

Received response

Example request:

curl --request GET \
    --get "https://api.psiproductfinder.de/v2/user-histories" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"fay.velda@example.com\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "message": "Server Error"
}

POST v2/user-histories

POST

https://api.psiproductfinder.de

/v2/user-histories

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Must be at least 1 character.

Example:

karley.hammes@example.org

product_id

string

required

Must be at least 1 character.

Example:

rdbxrbcauaccboewxnmduwgftseqnvcaieghynjbqjvmcxxsglhhiws

variant_id

string

required

Must be at least 1 character.

Example:

qzuyyfowmshtgmpmkxamtapmpbpvewgoseameiwpjkjuvxashugjfrdjyf

Auth

Bearer

Headers

Body

{ "email": "karley.hammes@example.org", "product_id": "rdbxrbcauaccboewxnmduwgftseqnvcaieghynjbqjvmcxxsglhhiws", "variant_id": "qzuyyfowmshtgmpmkxamtapmpbpvewgoseameiwpjkjuvxashugjfrdjyf" }

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/user-histories" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"karley.hammes@example.org\",
    \"product_id\": \"rdbxrbcauaccboewxnmduwgftseqnvcaieghynjbqjvmcxxsglhhiws\",
    \"variant_id\": \"qzuyyfowmshtgmpmkxamtapmpbpvewgoseameiwpjkjuvxashugjfrdjyf\"
}"

GET v2/bookmarks

GET

https://api.psiproductfinder.de

/v2/bookmarks

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.psiproductfinder.de/v2/bookmarks" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "message": "Server Error"
}

POST v2/bookmarks/store

POST

https://api.psiproductfinder.de

/v2/bookmarks/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

language

string

Must be one of:

de
en

Example:

locale

string

Must be one of:

de
en

Example:

description

string

Example:

Autem nihil nostrum qui autem ut ut.

headline

string

Example:

possimus

key

string

Example:

minus

keyvisual

string

Example:

name

string

Example:

ullam

show_as_slider

boolean

Example:

true

show_on_supplier_detail

boolean

Example:

false

show_request_all_button

boolean

Example:

true

video

string

Must be a valid URL.

Example:

https://blanda.com/totam-eveniet-aut-ipsam-ut-ut-cumque-neque.html

Auth

Bearer

Headers

Body

{ "language": "de", "locale": "en", "description": "Autem nihil nostrum qui autem ut ut.", "headline": "possimus", "key": "minus", "keyvisual": "id", "name": "ullam", "show_as_slider": true, "show_on_supplier_detail": false, "show_request_all_button": true, "video": "https:\/\/blanda.com\/totam-eveniet-aut-ipsam-ut-ut-cumque-neque.html" }

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/bookmarks/store" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"language\": \"de\",
    \"locale\": \"en\",
    \"description\": \"Autem nihil nostrum qui autem ut ut.\",
    \"headline\": \"possimus\",
    \"key\": \"minus\",
    \"keyvisual\": \"id\",
    \"name\": \"ullam\",
    \"show_as_slider\": true,
    \"show_on_supplier_detail\": false,
    \"show_request_all_button\": true,
    \"video\": \"https:\\/\\/blanda.com\\/totam-eveniet-aut-ipsam-ut-ut-cumque-neque.html\"
}"

GET v2/bookmarks/{bookmarkId}

GET

https://api.psiproductfinder.de

/v2/bookmarks/{bookmarkId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

bookmarkId

string

required

Example:

0004a030-2c25-11ec-b493-23defdd27f56

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.psiproductfinder.de/v2/bookmarks/0004a030-2c25-11ec-b493-23defdd27f56" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "message": "Server Error"
}

PATCH v2/bookmarks/{bookmarkId}/update

PATCH

https://api.psiproductfinder.de

/v2/bookmarks/{bookmarkId}/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

bookmarkId

string

required

Example:

0004a030-2c25-11ec-b493-23defdd27f56

Body Parameters

language

string

Must be one of:

de
en

Example:

locale

string

Must be one of:

de
en

Example:

description

string

Example:

Suscipit exercitationem expedita corporis aut consequatur necessitatibus eum.

headline

string

Example:

recusandae

key

string

Example:

aspernatur

keyvisual

string

Example:

sequi

name

string

Example:

eligendi

show_as_slider

boolean

Example:

false

show_on_supplier_detail

boolean

Example:

true

show_request_all_button

boolean

Example:

true

video

string

Must be a valid URL.

Example:

http://hyatt.com/accusamus-ab-repellendus-fuga-maxime-voluptatem-blanditiis-commodi

sort

object

Auth

Bearer

Headers

URL Parameters

Body

{ "language": "en", "locale": "de", "description": "Suscipit exercitationem expedita corporis aut consequatur necessitatibus eum.", "headline": "recusandae", "key": "aspernatur", "keyvisual": "sequi", "name": "eligendi", "show_as_slider": false, "show_on_supplier_detail": true, "show_request_all_button": true, "video": "http:\/\/hyatt.com\/accusamus-ab-repellendus-fuga-maxime-voluptatem-blanditiis-commodi", "sort": null }

Received response

Example request:

curl --request PATCH \
    "https://api.psiproductfinder.de/v2/bookmarks/0004a030-2c25-11ec-b493-23defdd27f56/update" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"language\": \"en\",
    \"locale\": \"de\",
    \"description\": \"Suscipit exercitationem expedita corporis aut consequatur necessitatibus eum.\",
    \"headline\": \"recusandae\",
    \"key\": \"aspernatur\",
    \"keyvisual\": \"sequi\",
    \"name\": \"eligendi\",
    \"show_as_slider\": false,
    \"show_on_supplier_detail\": true,
    \"show_request_all_button\": true,
    \"video\": \"http:\\/\\/hyatt.com\\/accusamus-ab-repellendus-fuga-maxime-voluptatem-blanditiis-commodi\"
}"

POST v2/bookmarks/{bookmarkId}/{variantIdentifier}/add

POST

https://api.psiproductfinder.de

/v2/bookmarks/{bookmarkId}/{variantIdentifier}/add

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

bookmarkId

string

required

Example:

0004a030-2c25-11ec-b493-23defdd27f56

variantIdentifier

string

required

Example:

Body Parameters

language

string

Must be one of:

de
en

Example:

locale

string

Must be one of:

de
en

Example:

description

string

Example:

Magnam maiores qui quis et adipisci exercitationem aut id.

headline

string

Example:

occaecati

key

string

Example:

molestiae

keyvisual

string

Example:

animi

name

string

Example:

est

show_as_slider

boolean

Example:

true

show_on_supplier_detail

boolean

Example:

true

show_request_all_button

boolean

Example:

false

video

string

Must be a valid URL.

Example:

https://mraz.info/voluptas-earum-rem-aut-natus-et.html

sort

object

Auth

Bearer

Headers

URL Parameters

Body

{ "language": "de", "locale": "de", "description": "Magnam maiores qui quis et adipisci exercitationem aut id.", "headline": "occaecati", "key": "molestiae", "keyvisual": "animi", "name": "est", "show_as_slider": true, "show_on_supplier_detail": true, "show_request_all_button": false, "video": "https:\/\/mraz.info\/voluptas-earum-rem-aut-natus-et.html", "sort": null }

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/bookmarks/0004a030-2c25-11ec-b493-23defdd27f56/ad/add" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"language\": \"de\",
    \"locale\": \"de\",
    \"description\": \"Magnam maiores qui quis et adipisci exercitationem aut id.\",
    \"headline\": \"occaecati\",
    \"key\": \"molestiae\",
    \"keyvisual\": \"animi\",
    \"name\": \"est\",
    \"show_as_slider\": true,
    \"show_on_supplier_detail\": true,
    \"show_request_all_button\": false,
    \"video\": \"https:\\/\\/mraz.info\\/voluptas-earum-rem-aut-natus-et.html\"
}"

POST v2/bookmarks/{bookmarkId}/{variantIdentifier}/remove

POST

https://api.psiproductfinder.de

/v2/bookmarks/{bookmarkId}/{variantIdentifier}/remove

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

bookmarkId

string

required

Example:

0004a030-2c25-11ec-b493-23defdd27f56

variantIdentifier

string

required

Example:

dolor

Body Parameters

language

string

Must be one of:

de
en

Example:

locale

string

Must be one of:

de
en

Example:

description

string

Example:

Deserunt culpa autem autem dolores.

headline

string

Example:

quas

key

string

Example:

velit

keyvisual

string

Example:

quam

name

string

Example:

eaque

show_as_slider

boolean

Example:

false

show_on_supplier_detail

boolean

Example:

true

show_request_all_button

boolean

Example:

true

video

string

Must be a valid URL.

Example:

https://www.hodkiewicz.com/reprehenderit-nihil-inventore-aut-temporibus-et

sort

object

Auth

Bearer

Headers

URL Parameters

Body

{ "language": "en", "locale": "en", "description": "Deserunt culpa autem autem dolores.", "headline": "quas", "key": "velit", "keyvisual": "quam", "name": "eaque", "show_as_slider": false, "show_on_supplier_detail": true, "show_request_all_button": true, "video": "https:\/\/www.hodkiewicz.com\/reprehenderit-nihil-inventore-aut-temporibus-et", "sort": null }

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/bookmarks/0004a030-2c25-11ec-b493-23defdd27f56/dolor/remove" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"language\": \"en\",
    \"locale\": \"en\",
    \"description\": \"Deserunt culpa autem autem dolores.\",
    \"headline\": \"quas\",
    \"key\": \"velit\",
    \"keyvisual\": \"quam\",
    \"name\": \"eaque\",
    \"show_as_slider\": false,
    \"show_on_supplier_detail\": true,
    \"show_request_all_button\": true,
    \"video\": \"https:\\/\\/www.hodkiewicz.com\\/reprehenderit-nihil-inventore-aut-temporibus-et\"
}"

POST v2/bookmarks/{bookmarkId}/duplicate

POST

https://api.psiproductfinder.de

/v2/bookmarks/{bookmarkId}/duplicate

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

bookmarkId

string

required

Example:

0004a030-2c25-11ec-b493-23defdd27f56

Body Parameters

name

string

Example:

nihil

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "nihil" }

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/bookmarks/0004a030-2c25-11ec-b493-23defdd27f56/duplicate" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nihil\"
}"

DELETE v2/bookmarks/{bookmarkId}/destroy

DELETE

https://api.psiproductfinder.de

/v2/bookmarks/{bookmarkId}/destroy

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

bookmarkId

string

required

Example:

0004a030-2c25-11ec-b493-23defdd27f56

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.psiproductfinder.de/v2/bookmarks/0004a030-2c25-11ec-b493-23defdd27f56/destroy" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Product Group Controller

Group Search

POST

https://api.psiproductfinder.de

/v2/productGroups/search

requires authentication

The Group Search allows you to query available group codes, which are also listed in the XLSX file (download). You can use the search parameter to filter results by a specific term and the locale parameter (en or de) to retrieve the corresponding results in your preferred language. This makes it easy to find and integrate group codes into your workflow.

Headers

Authorization

Example:

Bearer {YOUR_BEARER_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

locale

enum

Must be one of:

de
en

Example:

string

Example:

Jackets

Auth

Bearer

Headers

Body

{ "locale": "en", "search": "Jackets" }

Received response

Example request:

curl --request POST \
    "https://api.psiproductfinder.de/v2/productGroups/search" \
    --header "Authorization: Bearer {YOUR_BEARER_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"locale\": \"en\",
    \"search\": \"Jackets\"
}"

Example response:

[
    {
        "label": "Clothing",
        "options": [
            {
                "label": "Clothing > Jackets",
                "value": "01027009"
            },
            {
                "label": "Clothing > Quilted Jackets",
                "value": "01027025"
            },
            {
                "label": "Clothing > Wind Jackets, Windcheaters",
                "value": "01027031"
            },
            {
                "label": "Clothing > Winter Jackets",
                "value": "01027032"
            }
        ]
    },
    {
        "label": "Rucksacks",
        "options": [
            {
                "label": "Rucksacks > Rain Jackets",
                "value": "13206004"
            }
        ]
    }
]