Categories
Categories are entities that group certain Products.
Categories are entities that group certain Products.
List Categories
Retrieve all Categories.
GET
https://api.piggy.eu/api//product-categoriesHeaders
Authorization
Bearer {{ access_token | api_key }}
Accept
application/json
Response Example
{
"data": [
{
"uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
"external_identifier": "A-12345-B",
"name": "Coffee",
}
],
"meta": {
"page": 1,
"limit": 10,
"viewing_from": 1,
"viewing_to": 10,
"last_page": 1,
"total": 1
}
}Create Category
Creates a new Category in the Leat system and returns the Category entity.
POST
https://api.piggy.eu/api/v3/oauth/clients/product-categoriesHeaders
Authorization
Accept
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 Category
Response Example
{
"data": {
"uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
"external_identifier": "A-12345-B",
"name": "Coffee",
},
"meta": []
}Batch Create Categories
Creates a batch of Categories in the Leat system and returns the Category entities.
POST
https://api.piggy.eu/api/v3/oauth/clients/product-categories/batchHeaders
Authorization
Accept
Bearer {{ personal_access_token }}
application/json
Input parameters
categories
array of objects
required
List of Categories
external_identifier string
required
A unique identifier from your system
name string
required
The name of the Category
Response Example
{
"data": [
{
"uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
"external_identifier": "A-12345-B",
"name": "Coffee",
},
{
"uuid": "789bacs-asd1234-d8a6s7e",
"external_identifier": "B-12345-C",
"name": "Tea",
},
]
"meta": []
}Get Category
Get a specific Category in the Leat system.
GET
https://api.piggy.eu/api//product-categories/{uuid}Headers
Authorization
Bearer {{ access_token | api_key }}
Accept
application/json
Response Example
{
"data": {
"uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
"external_identifier": "A-12345-B",
"name": "Coffee",
},
"meta": []
}Find Category
Use the external_identifier to find a Category.
GET
https://api.piggy.eu/api/v3/oauth/clients/product-categories/findHeaders
Authorization
Accept
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": "Coffee",
},
"meta": []
}Find or Create Category
Finds an existing Category or creates a new Category in the Leat system and returns the Category entity.
POST
https://api.piggy.eu/api/v3/oauth/clients/product-categories/find-or-createHeaders
Authorization
Accept
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 Category
Response Example
{
"data": {
"uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
"external_identifier": "A-12345-B",
"name": "Coffee",
},
"meta": []
}Update Category
Updates a Category in the Leat system and returns the updated Category entity.
PUT
https://api.piggy.eu/api/v3/oauth/clients/product-categories/{uuid}Headers
Authorization
Accept
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 Category
Response Example
{
"data": {
"uuid": "62f6dc8c-4ff1-4c42-99ba-713c68ed10a0",
"external_identifier": "A-12345-B",
"name": "Coffee",
},
"meta": []
}Delete Category
Delete a specific Category in the Leat system.
DELETE
https://api.piggy.eu/api//product-categories/{uuid}Headers
Authorization
Bearer {{ access_token | api_key }}
Accept
application/json
Response Example
{
"data": null,
"meta": []
}