Products

Products are used for the Line Items of Orders.

List Products

Lists all Products in the Leat system.

GET

https://api.piggy.eu/api//products

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Response Example

{
    "data": [
        {
            "uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
            "external_identifier": "A-12345-B",
            "name": "Kelp Shake",
            "description": "A Kelp Shake with extra foam",
            "categories": []
        }
    ],
    "meta": {
        "page": 1,
        "limit": 10,
        "viewing_from": 1,
        "viewing_to": 10,
        "last_page": 1,
        "total": 1
    }
}

Create Product

Creates a new Product in the Leat system and returns the Product entity.

POST

https://api.piggy.eu/api/v3/oauth/clients/products

Headers

Authorization

Bearer {{ personal_access_token }}

application/json

Input parameters

external_identifier string

required

A unique identifier from your system

name string

required

The name of the Product

description string

optional

The description of the Product

categories

array of objects

optional

List of Categories that the product belongs to

uuid string

optional

UUID of the Category

external_identifier string

optional

External identifier of the Category

Response Example

{
    "data": {
        "uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
        "external_identifier": "A-12345-B",
        "name": "Kelp Shake",
        "description": "A Kelp Shake with extra foam",
        "categories": []
    },
    "meta": []
}

Batch Create Products

Creates a batch of Products in the Leat system and returns the Product entities.

POST

https://api.piggy.eu/api/v3/oauth/clients/products/batch

Headers

Authorization

Bearer {{ personal_access_token }}

application/json

Input parameters

products

array of objects

required

List of Products

external_identifier string

required

A unique identifier from your system

name string

required

The name of the Product

description string

optional

The description of the Product

categories

array of objects

optional

List of Categories that the product belongs to

uuid string

optional

UUID of the Category

external_identifier string

optional

External identifier of the Category

Response Example

{
    "data": [
        {
            "uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
            "external_identifier": "A-12345-B",
            "name": "Kelp Shake",
            "description": "A Kelp Shake with extra foam",
        },
        {
            "uuid": "789bacs-asd1234-d8a6s7e",
            "external_identifier": "B-12345-C",
            "name": "Seaweed Tea",
            "description": "A cup of Seaweed Tea",
        },
    ]
    "meta": []
}

Get Product

Get a specific Product in the Leat system.

GET

https://api.piggy.eu/api//products/{{uuid}}

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Response Example

{
    "data": {
        "uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
        "external_identifier": "A-12345-B",
        "name": "Kelp Shake",
        "description": "A Kelp Shake with extra foam",
        "categories": []    
    },
    "meta": []
}

Find Product

Use the external_identifier to find a Product.

GET

https://api.piggy.eu/api/v3/oauth/clients/products/find

Headers

Authorization

Bearer {{ personal_access_token }}

application/json

Input parameters

external_identifier string

required

A unique identifier from your system

Response Example

{
    "data": {
        "uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
        "external_identifier": "A-12345-B",
        "name": "Kelp Shake",
        "description": "A Kelp Shake with extra foam",
        "categories": []
    },
    "meta": []
}

Find or Create Product

Finds an existing Product or creates a new Product in the Leat system and returns the Product entity.

POST

https://api.piggy.eu/api/v3/oauth/clients/products/find-or-create

Headers

Authorization

Bearer {{ personal_access_token }}

application/json

Input parameters

external_identifier string

required

A unique identifier from your system

name string

optional

The name of the Product

description string

optional

The description of the Product

categories

array of objects

optional

List of Categories that the product belongs to

uuid string

optional

UUID of the Category

external_identifier string

optional

External identifier of the Category

Response Example

{
    "data": {
        "uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
        "external_identifier": "A-12345-B",
        "name": "Kelp Shake",
        "description": "A Kelp Shake with extra foam",
        "categories": []
    },
    "meta": []
}

Update Product

Updates a Product in the Leat system and returns the updated Product entity.

PUT

https://api.piggy.eu/api/v3/oauth/clients/products/{uuid}

Headers

Authorization

Bearer {{ personal_access_token }}

application/json

Input parameters

external_identifier string

optional

A unique identifier from your system

name string

optional

The name of the Product

description string

optional

The description of the Product

categories

array of objects

optional

List of Categories that the product belongs to

uuid string

optional

UUID of the Category

external_identifier string

optional

External identifier of the Category

Response Example

{
    "data": {
        "uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
        "external_identifier": "A-12345-B",
        "name": "Kelp Shake",
        "description": "A Kelp Shake with extra foam",
        "categories": []
    },
    "meta": []
}

Delete Product

Delete a specific Product in the Leat system.

DELETE

https://api.piggy.eu/api//products/{uuid}

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Response Example

{
    "data": null,
    "meta": []
}

Products

On this page