REST API Documentation

Postman collection → OpenAPI spec →

Introduction

REST API for custom integrations with external systems. Allows bulk import of products and categories.

Base URL: https://api.pobo.space

Authenticating requests

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

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

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Electronics Category<\/h1>
Latest electronic devices and accessories.<\/p>", "url": "https:\/\/example.com\/category\/electronics", "is_visible": true, "images": { "*": "https:\/\/picsum.photos\/id\/305\/1200\/700" } } }

Received response

Example request:

curl --request POST \
    "https://api.pobo.space/api/v1/categories/bulk-import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Example response:

{
    "success": true,
    "imported": 2,
    "updated": 0,
    "skipped": 1,
    "errors": [
        {
            "index": 0,
            "id": "A01.01.07",
            "errors": [
                "The name field is required."
            ]
        }
    ]
}

GET

https://api.pobo.space

/api/v1/categories/list

requires authentication

Get paginated list of categories with content in all supported languages.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

page

integer

The page number. Default: 1.

Example:

per_page

integer

Items per page (max 100). Default: 100.

Example:

is_edited

boolean

Filter by edited status. If true, returns only edited categories. If false, returns only unedited categories. If omitted, returns all categories.

Example:

true

last_update_time_from

string

Filter categories updated after this datetime. Format: Y-m-d H:i:s (e.g., 2024-01-01 14:30:00).

Example:

2024-01-01 14:30:00

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.pobo.space/api/v1/categories/list?page=1&per_page=10&is_edited=1&last_update_time_from=2024-01-01+14%3A30%3A00" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "categories": [
        {
            "id": "A01.01.07",
            "name": "Sample Category",
            "url": "https://example.com/category/123",
            "content": {
                "html": {
                    "default": "<h1>Sample Category Description</h1><p>This category is used for demonstration purposes.</p>",
                    "cs": "<h1>Popis vzorové kategorie</h1><p>Tato kategorie slouží pro demonstrační účely.</p>",
                    "en": "<h1>Sample Category Description</h1><p>This category is used for demonstration purposes.</p>",
                    "de": "<h1>Beispiel Kategoriebeschreibung</h1><p>Diese Kategorie wird zu Demonstrationszwecken verwendet.</p>",
                    "sk": "<h1>Popis vzorovej kategórie</h1><p>Táto kategória slúži na demonštračné účely.</p>"
                },
                "marketplace": {
                    "default": "<h1>Sample Category Description</h1><p>This category is used for demonstration purposes.</p>",
                    "cs": "<h1>Popis vzorové kategorie</h1><p>Tato kategorie slouží pro demonstrační účely.</p>",
                    "en": "<h1>Sample Category Description</h1><p>This category is used for demonstration purposes.</p>",
                    "de": "<h1>Beispiel Kategoriebeschreibung</h1><p>Diese Kategorie wird zu Demonstrationszwecken verwendet.</p>",
                    "sk": "<h1>Popis vzorovej kategórie</h1><p>Táto kategória slúži na demonštračné účely.</p>"
                }
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

Parameters

Bulk Import

POST

https://api.pobo.space

/api/v1/parameters/bulk-import

requires authentication

Import or update multiple parameters with their values at once. Maximum 100 parameters per request. Invalid parameters will be skipped and reported in the errors array.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

object

integer

required

The unique identifier of the parameter. Maximum 255 characters when converted to string.

Example:

name

string

required

The name of the parameter. Maximum 255 characters.

Example:

Color

values

string[]

required

Array of parameter values. At least one value is required.

Auth

Bearer

Headers

Body

{ "*": { "id": 1, "name": "Color", "values": { "*": { "id": 1, "value": "Red" } } } }

Received response

Example request:

curl --request POST \
    "https://api.pobo.space/api/v1/parameters/bulk-import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Example response:

{
    "success": true,
    "imported": 2,
    "updated": 0,
    "skipped": 1,
    "values_imported": 4,
    "values_updated": 0,
    "errors": [
        {
            "index": 0,
            "id": 1,
            "errors": [
                "The name field is required."
            ]
        }
    ]
}

Products

Bulk Import

POST

https://api.pobo.space

/api/v1/products/bulk-import

requires authentication

Import or update multiple products at once. Maximum 100 products per request. Invalid products will be skipped and reported in the errors array.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

object

string

required

The unique identifier of the product. Can be numeric or alphanumeric string. Maximum 255 characters.

Example:

PROD-123-ABC

name

string

required

The name of the product. Maximum 250 characters.

Example:

Wireless Bluetooth Headphones

short_description

string

nullable Short description of the product. Maximum 65000 characters.

Example:

Premium quality wireless headphones with noise cancellation.

description

string

nullable Long description of the product. Supports HTML. Maximum 65000 characters.

Example:

<h1>Wireless Bluetooth Headphones</h1><p>Experience superior sound quality with our premium wireless headphones featuring active noise cancellation and 30-hour battery life.</p>

url

string

required

Product URL. Maximum 255 characters.

Example:

https://example.com/product/wireless-headphones

is_visible

boolean

required

Whether the product is visible.

Example:

true

images

string[]

nullable Array of image URLs. Each URL maximum 650 characters. The first image will be set as image_preview.

categories_ids

string[]

nullable Array of category IDs to assign to this product. Can be numeric or alphanumeric strings.

parameters_ids

string[]

nullable Array of parameter value IDs to assign to this product.

Auth

Bearer

Headers

Body

{ "*": { "id": "PROD-123-ABC", "name": "Wireless Bluetooth Headphones", "short_description": "Premium quality wireless headphones with noise cancellation.", "description": "

Wireless Bluetooth Headphones<\/h1>
Experience superior sound quality with our premium wireless headphones featuring active noise cancellation and 30-hour battery life.<\/p>", "url": "https:\/\/example.com\/product\/wireless-headphones", "is_visible": true, "images": { "": "https:\/\/picsum.photos\/id\/310\/1200\/700" }, "categories_ids": { "": "A01.01.07" }, "parameters_ids": { "*": 1 } } }

Received response

Example request:

curl --request POST \
    "https://api.pobo.space/api/v1/products/bulk-import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Example response:

{
    "success": true,
    "imported": 2,
    "updated": 0,
    "skipped": 1,
    "errors": [
        {
            "index": 0,
            "id": "PROD-123",
            "errors": [
                "The name field is required."
            ]
        }
    ]
}

Product List

GET

https://api.pobo.space

/api/v1/products/list

requires authentication

Get paginated list of products with content in all supported languages.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

page

integer

The page number. Default: 1.

Example:

per_page

integer

Items per page (max 100). Default: 100.

Example:

is_edited

boolean

Filter by edited status. If true, returns only edited products. If false, returns only unedited products. If omitted, returns all products.

Example:

true

last_update_time_from

string

Filter products updated after this datetime. Format: Y-m-d H:i:s (e.g., 2024-01-01 14:30:00).

Example:

2024-01-01 14:30:00

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.pobo.space/api/v1/products/list?page=1&per_page=10&is_edited=1&last_update_time_from=2024-01-01+14%3A30%3A00" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "products": [
        {
            "id": "PROD-123",
            "name": "Sample Product",
            "short_description": "This is a sample product.",
            "url": "https://example.com/product/123",
            "content": {
                "html": {
                    "default": "<h1>Sample Product Description</h1><p>This product is used for demonstration purposes.</p>",
                    "cs": "<h1>Popis vzorového produktu</h1><p>Tento produkt slouží pro demonstrační účely.</p>",
                    "en": "<h1>Sample Product Description</h1><p>This product is used for demonstration purposes.</p>",
                    "de": "<h1>Beispiel Produktbeschreibung</h1><p>Dieses Produkt wird zu Demonstrationszwecken verwendet.</p>",
                    "sk": "<h1>Popis vzorového produktu</h1><p>Tento produkt slúži na demonštračné účely.</p>"
                },
                "marketplace": {
                    "default": "<h1>Sample Product Description</h1><p>This product is used for demonstration purposes.</p>",
                    "cs": "<h1>Popis vzorového produktu</h1><p>Tento produkt slouží pro demonstrační účely.</p>",
                    "en": "<h1>Sample Product Description</h1><p>This product is used for demonstration purposes.</p>",
                    "de": "<h1>Beispiel Produktbeschreibung</h1><p>Dieses Produkt wird zu Demonstrationszwecken verwendet.</p>",
                    "sk": "<h1>Popis vzorového produktu</h1><p>Tento produkt slúži na demonštračné účely.</p>"
                }
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

REST API Documentation

REST API Documentation

Introduction

Authenticating requests

Categories

Bulk Import

Headers

Body Parameters

Electronics Category<\/h1>Latest electronic devices and accessories.<\/p>", "url": "https:\/\/example.com\/category\/electronics", "is_visible": true, "images": { "*": "https:\/\/picsum.photos\/id\/305\/1200\/700" } } }

Category List

Headers

Query Parameters

Parameters

Bulk Import

Headers

Body Parameters

Products

Bulk Import

Headers

Body Parameters

Product List

Headers

Query Parameters

Electronics Category<\/h1>
Latest electronic devices and accessories.<\/p>", "url": "https:\/\/example.com\/category\/electronics", "is_visible": true, "images": { "*": "https:\/\/picsum.photos\/id\/305\/1200\/700" } } }