openapi: 3.0.3
info:
title: 'Garchi CMS API documentation v2'
description: 'The API resources allows you to use most of the features of Garchi Headless CMS to create your own Headless app.'
version: 1.0.0
servers:
-
url: 'https://garchi.co.uk'
tags:
-
name: Spaces
description: ''
-
name: Category
description: ''
-
name: Item
description: ''
-
name: 'Headless Web'
description: ''
-
name: Reviews
description: ''
-
name: 'Compound Query'
description: ''
-
name: Reaction
description: ''
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by visiting your dashboard. To create a new token check the Subscription section in your dashboard.'
security:
-
default: []
paths:
/api/v2/spaces:
get:
summary: 'List all spaces'
operationId: listAllSpaces
description: ''
parameters:
-
in: query
name: size
description: 'Number of records to fetch in one page. By default it is set to 10.'
example: 10
required: false
schema:
type: integer
description: 'Number of records to fetch in one page. By default it is set to 10.'
example: 10
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
uid: 3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1
name: 'Jane Doe'
logo_url: 'https://assets.garchi.co.uk/examples/seller-logo.jpg'
number_of_items: 3
agent_description: 'This is ai agent description'
links:
first: 'https://garchi.co.uk/api/v2/spaces?page=1'
last: 'https://garchi.co.uk/api/v2/spaces?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/spaces?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
path: 'https://garchi.co.uk/api/v2/spaces'
per_page: 10
to: 1
total: 1
properties:
data:
type: array
example:
-
uid: 3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1
name: 'Jane Doe'
logo_url: 'https://assets.garchi.co.uk/examples/seller-logo.jpg'
number_of_items: 3
agent_description: 'This is ai agent description'
items:
type: object
properties:
uid:
type: string
example: 3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1
name:
type: string
example: 'Jane Doe'
logo_url:
type: string
example: 'https://assets.garchi.co.uk/examples/seller-logo.jpg'
number_of_items:
type: integer
example: 3
agent_description:
type: string
example: 'This is ai agent description'
links:
type: object
properties:
first:
type: string
example: 'https://garchi.co.uk/api/v2/spaces?page=1'
last:
type: string
example: 'https://garchi.co.uk/api/v2/spaces?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/spaces?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
path:
type: string
example: 'https://garchi.co.uk/api/v2/spaces'
per_page:
type: integer
example: 10
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- Spaces
'/api/v2/space/{uid}':
get:
summary: 'Get Space details'
operationId: getSpaceDetails
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
uid: 52690642-cc29-4c4d-a9dc-752d4036869e9b64f419-c900-49a8-9109-208a
name: 'Jane Doe'
logo_url: 'https://assets.garchi.co.uk/examples/seller-logo.svg'
number_of_items: 24
agent_description: 'This is agent description'
properties:
data:
type: object
properties:
uid:
type: string
example: 52690642-cc29-4c4d-a9dc-752d4036869e9b64f419-c900-49a8-9109-208a
name:
type: string
example: 'Jane Doe'
logo_url:
type: string
example: 'https://assets.garchi.co.uk/examples/seller-logo.svg'
number_of_items:
type: integer
example: 24
agent_description:
type: string
example: 'This is agent description'
tags:
- Spaces
parameters:
-
in: path
name: uid
description: 'space uid'
example: 3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1
required: true
schema:
type: string
/api/v2/space:
post:
summary: 'Create a new space'
operationId: createANewSpace
description: 'Creates a new space.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
uid: 3cbec0da-0c9f-4cd3-99e3-0b962477816dededd79c-d150-45ec-93b6-859c2f52b234
name: 'Jane Doe'
logo_url: NA
number_of_items: null
agent_description: NA
properties:
data:
type: object
properties:
uid:
type: string
example: 3cbec0da-0c9f-4cd3-99e3-0b962477816dededd79c-d150-45ec-93b6-859c2f52b234
name:
type: string
example: 'Jane Doe'
logo_url:
type: string
example: NA
number_of_items:
type: string
example: null
nullable: true
agent_description:
type: string
example: NA
422:
description: 'Plan allowance reached'
content:
application/json:
schema:
type: object
example:
message: 'The space allowance for this plan has been reached.'
errors:
limit:
- 'The space allowance for this plan has been reached.'
properties:
message:
type: string
example: 'The space allowance for this plan has been reached.'
errors:
type: object
properties:
limit:
type: array
example:
- 'The space allowance for this plan has been reached.'
items:
type: string
tags:
- Spaces
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: "Seller's full name"
example: '"Jane Doe"'
logo:
type: string
format: binary
description: "Seller's logo image file"
required:
- name
'/api/v2/delete/space/{uid}':
post:
summary: 'Delete a space record'
operationId: deleteASpaceRecord
description: 'Deletes space record and associated records.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: 'Space details deleted successfully'
properties:
data:
type: string
example: 'Space details deleted successfully'
tags:
- Spaces
parameters:
-
in: path
name: uid
description: "Seller's uid"
example: 635c09ed-d55f-407d-a4c0-45f5ad9f2b44c2321f02-a835-4024-9b83-c4a1
required: true
schema:
type: string
'/api/v2/update/space/{uid}':
post:
summary: 'Update a space'
operationId: updateASpace
description: 'Updates space details.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: 'Space details updated successfully'
properties:
data:
type: string
example: 'Space details updated successfully'
tags:
- Spaces
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: "Seller's full name"
example: '"Jane Doe"'
logo:
type: string
format: binary
description: "Seller's logo image file"
parameters:
-
in: path
name: uid
description: "Seller's uid"
example: 635c09ed-d55f-407d-a4c0-45f5ad9f2b44c2321f02-a835-4024-9b83-c4a1
required: true
schema:
type: string
/api/v2/category:
post:
summary: 'Create a category'
operationId: createACategory
description: 'Creates a new cateogry for a space'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 43
name: Events
rank: 1
created_at: '2024-05-01 10:12:45'
properties:
data:
type: object
properties:
id:
type: integer
example: 43
name:
type: string
example: Events
rank:
type: integer
example: 1
created_at:
type: string
example: '2024-05-01 10:12:45'
422:
description: 'Plan allowance reached'
content:
application/json:
schema:
type: object
example:
message: 'The categories allowance for this plan has been reached.'
errors:
limit:
- 'The categories allowance for this plan has been reached.'
properties:
message:
type: string
example: 'The categories allowance for this plan has been reached.'
errors:
type: object
properties:
limit:
type: array
example:
- 'The categories allowance for this plan has been reached.'
items:
type: string
tags:
- Category
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
space_uid:
type: string
description: 'UID of the space.'
example: 635c09ed-d55f-407d-a4c0-45f5ad9f2b44c2321f02-a835-4024-9b83-c4a1
category:
type: string
description: 'Category name'
example: voluptatem
required:
- space_uid
- category
'/api/v2/delete/category/{space_uid}/{category_id}':
post:
summary: 'Delete a category'
operationId: deleteACategory
description: 'Deletes a category and all the associated items of that category for a space'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: 'Category deleted successfully'
properties:
data:
type: string
example: 'Category deleted successfully'
tags:
- Category
parameters:
-
in: path
name: space_uid
description: 'UID of the space.'
example: 635c09ed-d55f-407d-a4c0-45f5ad9f2b44c2321f02-a835-4024-9b83-c4a1
required: true
schema:
type: string
-
in: path
name: category_id
description: 'Id of the category.'
example: 43
required: true
schema:
type: integer
'/api/v2/update/category/{category_id}':
post:
summary: 'Update a category'
operationId: updateACategory
description: 'Update a cateogry for a space'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: 'Category updated successfully'
properties:
data:
type: string
example: 'Category updated successfully'
tags:
- Category
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
space_uid:
type: string
description: 'UID of the space.'
example: 635c09ed-d55f-407d-a4c0-45f5ad9f2b44c2321f02-a835-4024-9b83-c4a1
category:
type: string
description: 'Category name'
example: veritatis
required:
- space_uid
- category
parameters:
-
in: path
name: category_id
description: 'Id of the category.'
example: 43
required: true
schema:
type: integer
'/api/v2/space/{uid}/categories':
get:
summary: 'Get all Categories for a space'
operationId: getAllCategoriesForASpace
description: 'Returns all the categories of the specified space.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 43
name: Events
rank: 1
created_at: '2024-05-01 10:12:45'
-
id: 44
name: Workshops
rank: 2
created_at: '2024-05-02 08:30:10'
properties:
data:
type: array
example:
-
id: 43
name: Events
rank: 1
created_at: '2024-05-01 10:12:45'
-
id: 44
name: Workshops
rank: 2
created_at: '2024-05-02 08:30:10'
items:
type: object
properties:
id:
type: integer
example: 43
name:
type: string
example: Events
rank:
type: integer
example: 1
created_at:
type: string
example: '2024-05-01 10:12:45'
tags:
- Category
parameters:
-
in: path
name: uid
description: 'Uid of the space.'
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
required: true
schema:
type: string
/api/v2/categories:
get:
summary: 'Get all Categories'
operationId: getAllCategories
description: 'Returns all the categories for all the spaces.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 43
name: Events
rank: 1
created_at: '2024-05-01 10:12:45'
-
id: 44
name: Workshops
rank: 2
created_at: '2024-05-02 08:30:10'
properties:
data:
type: array
example:
-
id: 43
name: Events
rank: 1
created_at: '2024-05-01 10:12:45'
-
id: 44
name: Workshops
rank: 2
created_at: '2024-05-02 08:30:10'
items:
type: object
properties:
id:
type: integer
example: 43
name:
type: string
example: Events
rank:
type: integer
example: 1
created_at:
type: string
example: '2024-05-01 10:12:45'
tags:
- Category
/api/v2/item:
post:
summary: 'Create a new item'
operationId: createANewItem
description: 'Adds a new item for a space'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
item_id: 50
sku: SKU111111
external_link: null
slug: item-abc
parent_id: null
children_count: 0
name: 'Item ABC'
stock: 5
price: 10
scratched_price: 5
one_liner: null
description: 'This is an amazing item'
delivery_type: null
main_image: NA
other_images: []
space:
uid: ca457162-6d04-4c3a-a3f6-2ab3e21b0fd00cca6914-5e72-4d54-b9db-fcf9
name: 'Shop XYZ'
avg_rating: null
scheduled_for: null
agent_description: 'A lightweight product summary that helps AI agents understand when to recommend this item.'
created: '2026-10-12 10:15:00'
updated: '2026-10-12 10:15:00'
properties:
data:
type: object
properties:
item_id:
type: integer
example: 50
sku:
type: string
example: SKU111111
external_link:
type: string
example: null
nullable: true
slug:
type: string
example: item-abc
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Item ABC'
stock:
type: integer
example: 5
price:
type: integer
example: 10
scratched_price:
type: integer
example: 5
one_liner:
type: string
example: null
nullable: true
description:
type: string
example: 'This is an amazing item'
delivery_type:
type: string
example: null
nullable: true
main_image:
type: string
example: NA
other_images:
type: array
example: []
space:
type: object
properties:
uid:
type: string
example: ca457162-6d04-4c3a-a3f6-2ab3e21b0fd00cca6914-5e72-4d54-b9db-fcf9
name:
type: string
example: 'Shop XYZ'
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
agent_description:
type: string
example: 'A lightweight product summary that helps AI agents understand when to recommend this item.'
created:
type: string
example: '2026-10-12 10:15:00'
updated:
type: string
example: '2026-10-12 10:15:00'
422:
description: 'Plan allowance reached'
content:
application/json:
schema:
type: object
example:
message: 'The items allowance for this plan has been reached.'
errors:
limit:
- 'The items allowance for this plan has been reached.'
properties:
message:
type: string
example: 'The items allowance for this plan has been reached.'
errors:
type: object
properties:
limit:
type: array
example:
- 'The items allowance for this plan has been reached.'
items:
type: string
tags:
- Item
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
space_uid:
type: string
description: 'UID of the space.'
example: ca457162-6d04-4c3a-a3f6-2ab3e21b0fd00cca6914-5e72-4d54-b9db-fcf9
name:
type: string
description: 'Name of the item.'
example: '"item ABC"'
categories:
type: array
description: 'Ids of the categories to which the item should belong.'
example:
- 44
- 45
items:
type: integer
sku:
type: string.
description: 'SKU of the item if applicable.'
example: SKU11111
stock:
type: integer
description: 'Quantity/stock of the item.'
example: 5
price:
type: Price
description: 'of the item.'
example: '10'
scratched_price:
type: number
description: 'Marketing or promotional price of the item.'
example: 5.0
detail_description:
type: string.
description: 'Detail description body of the item.'
example: 'This is an amazing item'
agent_description:
type: string
description: 'AI-facing description of the item.'
example: 'A lightweight product summary that helps AI agents understand when to recommend this item.'
external_url:
type: string.
description: 'If the item is an external item and has an external url.'
example: 'https://productabc.com'
slug:
type: string.
description: 'Slug of the item.'
example: item-abc
parent_id:
type: integer
description: 'Id of the item this item is inside, such as the product a variant belongs to. It must be in the same space, and items nest up to three levels.'
example: 48
required:
- space_uid
- name
- categories
/api/v2/delete/item:
post:
summary: 'Delete an item'
operationId: deleteAnItem
description: "Deletes an item and it's associated meta data and attributes for a space"
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: 'Item deleted successfully'
properties:
data:
type: string
example: 'Item deleted successfully'
tags:
- Item
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
item_id:
type: integer
description: 'required. Id of the item.'
example: 50
space_uid:
type: string
description: 'required. UID of the space.'
example: ca457162-6d04-4c3a-a3f6-2ab3e21b0fd00cca6914-5e72-4d54-b9db-fcf9
/api/v2/update/item:
post:
summary: 'Update a item'
operationId: updateAItem
description: 'Update a item for a space'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: 'Item updated successfully'
properties:
data:
type: string
example: 'Item updated successfully'
tags:
- Item
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
item_id:
type: integer
description: 'required. Id of the item.'
example: 50
space_uid:
type: string
description: 'required. UID of the space.'
example: ca457162-6d04-4c3a-a3f6-2ab3e21b0fd00cca6914-5e72-4d54-b9db-fcf9
name:
type: string
description: 'Name of the item.'
example: '"item ABC"'
sku:
type: string
description: 'SKU of the item if applicable.'
example: SKU11111
stock:
type: integer
description: 'Quantity/stock of the item.'
example: 5
categories:
type: array
description: 'Cateogory id to which the item should belong.'
example:
- 44
items:
type: integer
price:
type: number
description: 'Price of the item.'
example: 10.0
scratched_price:
type: float.
description: 'Marketing or promotional price of the item.'
example: '5'
detail_description:
type: string.
description: 'Detail description body of the item.'
example: 'This is an amazing item'
agent_description:
type: string
description: 'AI-facing description of the item.'
example: 'A lightweight product summary that helps AI agents understand when to recommend this item.'
external_url:
type: string.
description: 'If the item is an external item and has an external url.'
example: 'https://itemabc.com'
make_public:
type: boolean.
description: 'If the item should be made public or not.'
example: 'true'
slug:
type: string.
description: 'Slug of the item.'
example: item-abc
parent_id:
type: integer
description: 'Id of the item this item is inside, in the same space. Send null to take the item out on its own; leave it out to keep its place.'
example: 48
/api/v2/item_meta:
post:
summary: 'Create meta information about a item'
operationId: createMetaInformationAboutAItem
description: 'This api allows you to add extra information or meta data for a item. The data is added as a key value pair'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 606
key: website
value: 'https://example.com'
type: url
properties:
data:
type: array
example:
-
id: 606
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 606
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
tags:
- Item
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
meta:
type: array
description: 'required. Array of meta information.'
example:
-
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
key:
type: string
description: 'required. Key of for the meta information.'
example: website
type:
type: string
description: 'required. Type of the key value. Allowed values are string, array, url, object, numeric, email, date, color, icon_hero, icon_lucid.'
example: url
value:
type: string
description: 'required. Value for the key.'
example: 'https://example.com'
item_id:
type: integer
description: 'required. Id of the item.'
example: 51
/api/v2/delete/item_meta:
post:
summary: 'Delete meta information about a item for a space'
operationId: deleteMetaInformationAboutAItemForASpace
description: 'This api allows you to delete extra information or meta data for a item. The data is added as a key value pair'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: 'Item meta deleted successfully'
properties:
data:
type: string
example: 'Item meta deleted successfully'
tags:
- Item
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
meta_id:
type: integer
description: 'Meta id of the item meta info.'
example: 55
item_id:
type: integer
description: 'required. Id of the item.'
example: 51
space_uid:
type: string
description: 'required. UID of the space.'
example: ca457162-6d04-4c3a-a3f6-2ab3e21b0fd00cca6914-5e72-4d54-b9db-fcf9
required:
- meta_id
/api/v2/update/item_meta:
post:
summary: 'Update meta information about a item for a space'
operationId: updateMetaInformationAboutAItemForASpace
description: 'This api allows you to update extra information or meta data for a item. The data is added as a key value pair'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data: 'Item meta updated successfully'
properties:
data:
type: string
example: 'Item meta updated successfully'
tags:
- Item
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
key:
type: string.
description: 'Key of for the meta information.'
example: website
type:
type: string.
description: 'Type of the key value. Allowed values are string, array, url, object, numeric, email, date, color, icon_hero, icon_lucid.'
example: url
value:
type: string.
description: 'Value for the key.'
example: 'https://example.com'
meta_id:
type: integer
description: 'Meta id of the item meta info.'
example: 55
item_id:
type: integer
description: 'required. Id of the item.'
example: 51
required:
- meta_id
'/api/v2/space/{uid}/items':
get:
summary: 'List all items for a space'
operationId: listAllItemsForASpace
description: 'Returns list of all the items with pagination links for a particular space'
parameters:
-
in: query
name: size
description: 'int. Max number of entries on one page or size of chunk per page. By default it is set to 10.'
example: 12
required: false
schema:
type: integer
description: 'int. Max number of entries on one page or size of chunk per page. By default it is set to 10.'
example: 12
-
in: query
name: order_key
description: 'string. Key to order the items by. Allowed values are name, price, created, meta.*. meta.* is useful if you want to order items based on the item meta information keys.'
example: price
required: false
schema:
type: string
description: 'string. Key to order the items by. Allowed values are name, price, created, meta.*. meta.* is useful if you want to order items based on the item meta information keys.'
example: price
-
in: query
name: order_by
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
required: false
schema:
type: string
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
-
in: query
name: reactions
description: 'string. If you want to include or exclude reactions for the items.'
example: include
required: false
schema:
type: string
description: 'string. If you want to include or exclude reactions for the items.'
example: include
-
in: query
name: children
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
required: false
schema:
type: string
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
-
in: query
name: description
description: 'string. If you want to include or exclude markdown description for the items.'
example: exclude
required: false
schema:
type: string
description: 'string. If you want to include or exclude markdown description for the items.'
example: exclude
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
links:
first: 'https://garchi.co.uk/api/v2/items?page=1'
last: 'https://garchi.co.uk/api/v2/items?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
path: 'https://garchi.co.uk/api/v2/items'
per_page: 10
to: 1
total: 1
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
id: 11
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 11
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
links:
type: object
properties:
first:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
last:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
path:
type: string
example: 'https://garchi.co.uk/api/v2/items'
per_page:
type: integer
example: 10
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- Item
parameters:
-
in: path
name: uid
description: ''
example: et
required: true
schema:
type: string
/api/v2/items/semantic-search:
get:
summary: 'Semantic search items'
operationId: semanticSearchItems
description: "Before you use this API make sure to create embeddings from your dashboard .\n\nThis endpoint returns the list of items based on semantic search. The search is based on the description and name of the items.\n\nThe response body is similar to list all items api ."
parameters:
-
in: query
name: q
description: 'Search query.'
example: 'web app'
required: true
schema:
type: string
description: 'Search query.'
example: 'web app'
-
in: query
name: threshold
description: 'Threshold for the search between 0-1. Default value is 0.5.'
example: 0.5
required: false
schema:
type: number
description: 'Threshold for the search between 0-1. Default value is 0.5.'
example: 0.5
-
in: query
name: reactions
description: 'If you want to include or exclude reactions for the items.'
example: include
required: false
schema:
type: string
description: 'If you want to include or exclude reactions for the items.'
example: include
-
in: query
name: children
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
required: false
schema:
type: string
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
-
in: query
name: description
description: 'If you want to include or exclude markdown description for the items.'
example: exclude
required: false
schema:
type: string
description: 'If you want to include or exclude markdown description for the items.'
example: exclude
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
similarity: 0.82
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
similarity: 0.82
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
id: 11
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 11
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
similarity:
type: number
example: 0.82
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
tags:
- Item
/api/v2/items/featured:
get:
summary: 'List all featured items'
operationId: listAllFeaturedItems
description: "This endpoint returns the list of featured items that you set from your dashboard.\nThe response body is similar to list all items api ."
parameters:
-
in: query
name: reactions
description: 'string. If you want to include or exclude reactions for the items.'
example: include
required: false
schema:
type: string
description: 'string. If you want to include or exclude reactions for the items.'
example: include
-
in: query
name: children
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
required: false
schema:
type: string
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
-
in: query
name: description
description: 'string. If you want to include or exclude markdown description for the items.'
example: exclude
required: false
schema:
type: string
description: 'string. If you want to include or exclude markdown description for the items.'
example: exclude
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
tags:
- Item
'/api/v2/item/{item}':
get:
summary: 'Get Item Details'
operationId: getItemDetails
description: 'Returns details of a single item based on the item_id or slug passed.'
parameters:
-
in: query
name: reactions
description: 'If you want to include or exclude reactions for the items.'
example: include
required: false
schema:
type: string
description: 'If you want to include or exclude reactions for the items.'
example: include
-
in: query
name: children
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
required: false
schema:
type: string
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
id: 11
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 11
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
tags:
- Item
parameters:
-
in: path
name: item
description: 'id or slug of the item.'
example: '3'
required: true
schema:
type: string
/api/v2/items:
get:
summary: 'List all items'
operationId: listAllItems
description: 'Returns list of all the items with pagination links. You can also use this api to search items by their name, slug, or category.'
parameters:
-
in: query
name: size
description: 'int. Max number of entries on one page or size of chunk per page. By default it is set to 10.'
example: 10
required: false
schema:
type: integer
description: 'int. Max number of entries on one page or size of chunk per page. By default it is set to 10.'
example: 10
-
in: query
name: search_keyword
description: 'string. Could be name of the item, slug of the item, or category name.'
example: 'Web app with'
required: false
schema:
type: string
description: 'string. Could be name of the item, slug of the item, or category name.'
example: 'Web app with'
-
in: query
name: order_key
description: 'string. Key to order the items by. Allowed values are name, price, created, meta.*. meta.* is useful if you want to order items based on the item meta information keys.'
example: price
required: false
schema:
type: string
description: 'string. Key to order the items by. Allowed values are name, price, created, meta.*. meta.* is useful if you want to order items based on the item meta information keys.'
example: price
-
in: query
name: order_by
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
required: false
schema:
type: string
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
-
in: query
name: reactions
description: 'string. If you want to include or exclude reactions for the items.'
example: include
required: false
schema:
type: string
description: 'string. If you want to include or exclude reactions for the items.'
example: include
-
in: query
name: children
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
required: false
schema:
type: string
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
-
in: query
name: description
description: 'string. If you want to include or exclude markdown description for the items.'
example: exclude
required: false
schema:
type: string
description: 'string. If you want to include or exclude markdown description for the items.'
example: exclude
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
links:
first: 'https://garchi.co.uk/api/v2/items?page=1'
last: 'https://garchi.co.uk/api/v2/items?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
path: 'https://garchi.co.uk/api/v2/items'
per_page: 10
to: 1
total: 1
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
id: 11
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 11
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
links:
type: object
properties:
first:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
last:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
path:
type: string
example: 'https://garchi.co.uk/api/v2/items'
per_page:
type: integer
example: 10
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- Item
/api/v2/items/filter:
post:
summary: 'Filter items'
operationId: filterItems
description: "Based on the filters passed, does logically and of all filters and returns the list of items with pagination.\nThe response body is similar to list all items api .\nThe accepted filters are spaces, categories and priceOrder. If any of these filter is null or blank or empty then it will be ignored."
parameters:
-
in: query
name: reactions
description: 'string. If you want to include or exclude reactions for the items.'
example: include
required: false
schema:
type: string
description: 'string. If you want to include or exclude reactions for the items.'
example: include
-
in: query
name: children
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
required: false
schema:
type: string
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
-
in: query
name: order_key
description: 'string. Key to order the items by. Allowed values are name, price, created, meta.*. meta.* is useful if you want to order items based on the item meta information keys.'
example: price
required: false
schema:
type: string
description: 'string. Key to order the items by. Allowed values are name, price, created, meta.*. meta.* is useful if you want to order items based on the item meta information keys.'
example: price
-
in: query
name: order_by
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
required: false
schema:
type: string
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
-
in: query
name: description
description: 'string. If you want to include or exclude markdown description for the items.'
example: exclude
required: false
schema:
type: string
description: 'string. If you want to include or exclude markdown description for the items.'
example: exclude
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
links:
first: 'https://garchi.co.uk/api/v2/items?page=1'
last: 'https://garchi.co.uk/api/v2/items?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
path: 'https://garchi.co.uk/api/v2/items'
per_page: 10
to: 1
total: 1
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
id: 11
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 11
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
links:
type: object
properties:
first:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
last:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
path:
type: string
example: 'https://garchi.co.uk/api/v2/items'
per_page:
type: integer
example: 10
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- Item
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
spaces:
type: 'string[].'
description: 'Array of uid of spaces.'
example: "['2z5088d1-8772-2912-ab9w-cbdd8bcd806fb6138bbf-296e-94b4-9cf1-03x1']"
categories:
type: 'integer[].'
description: 'Array of category id.'
example: '[23,4,1]'
priceOrder:
type: string.
description: "Takes either of one value. 'low-high', 'high-low'."
example: '"low-high"'
size:
type: int.
description: 'Size of the paginated data chunk.'
example: '10'
/api/v2/items/filter/bymeta:
post:
summary: 'Filter items by meta values'
operationId: filterItemsByMetaValues
description: "Based on the filters passed for the meta data (Extra details added for an item) and the operation specified, filters the items.\nDoes logical and of the filters.\nThe response body is similar to list all items api ."
parameters:
-
in: query
name: order_key
description: 'string. Key to order the items by. Allowed values are name, price, created, meta.*. meta.* is useful if you want to order items based on the item meta information keys.'
example: price
required: false
schema:
type: string
description: 'string. Key to order the items by. Allowed values are name, price, created, meta.*. meta.* is useful if you want to order items based on the item meta information keys.'
example: price
-
in: query
name: order_by
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
required: false
schema:
type: string
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
-
in: query
name: reactions
description: 'string. If you want to include or exclude reactions for the items.'
example: include
required: false
schema:
type: string
description: 'string. If you want to include or exclude reactions for the items.'
example: include
-
in: query
name: children
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
required: false
schema:
type: string
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
id: 11
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 11
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
tags:
- Item
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
meta_filters:
type: array
description: 'Array of key value pairs where key refers to the meta key and value refers to the match you are looking for.'
example:
- []
items:
type: object
properties:
key:
type: required
description: 'Key that you are looking for.'
example: date
value:
type: required
description: 'Value that should be matched for the specified key.'
example: "['2021-11-21', '2020-12-12']"
operator:
type: required
description: 'Type of operator to be used. Allowed operators equals, in, like, gte, lte.'
example: in
required:
- meta_filters
/api/v2/items/byids:
post:
summary: 'List items by list of ids'
operationId: listItemsByListOfIds
description: "This endpoint returns list of items based on items_ids given. It could be use to list specific list of items on landing page.\nThe response body is similar to list all items api ."
parameters:
-
in: query
name: order_key
description: 'string. Key to order the items by. Allowed values are name, price, created, meta.*. meta.* is useful if you want to order items based on the item meta information keys.'
example: price
required: false
schema:
type: string
description: 'string. Key to order the items by. Allowed values are name, price, created, meta.*. meta.* is useful if you want to order items based on the item meta information keys.'
example: price
-
in: query
name: order_by
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
required: false
schema:
type: string
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
-
in: query
name: reactions
description: 'string. If you want to include or exclude reactions for the items.'
example: include
required: false
schema:
type: string
description: 'string. If you want to include or exclude reactions for the items.'
example: include
-
in: query
name: children
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
required: false
schema:
type: string
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
-
in: query
name: description
description: 'string. If you want to include or exclude markdown description for the items.'
example: exclude
required: false
schema:
type: string
description: 'string. If you want to include or exclude markdown description for the items.'
example: exclude
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
id: 11
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 11
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
tags:
- Item
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
item_ids:
type: array
description: 'List of item ids.'
example:
- 15
- 29
items:
type: integer
required:
- item_ids
'/api/v2/space/{uid}/items/query':
post:
summary: 'Query items'
operationId: queryItems
description: "Find the published items of a space with any combination of conditions on their own fields and their metadata, including values nested inside JSON objects and lists.
\n\nA condition is `{\"field\": ..., \"op\": ..., \"value\": ...}`. Group conditions with `{\"all\": [...]}` (every one must match) or `{\"any\": [...]}` (at least one must match); groups can be nested. A plain list of conditions means all.
\n\nItem fields: item_id, name, slug, sku, price, scratched_price, stock, created, updated, category (category ids), type (item type slugs, such as \"product\").
\nMetadata fields: `meta.`, with dots into JSON objects, for example `meta.specs.weight`. A JSON list matches when any of its elements does: `meta.tags` eq \"vegan\", or `meta.variants.size` eq \"M\".
\n\nOperators: eq, ne, gt, gte, lt, lte, between ([from, to]), in, not_in, contains, starts_with, exists, not_exists, and has_all (lists: every value present). Numbers compare as numbers, ISO dates as dates, and text case-insensitively.
\n\nSort by up to three item or metadata fields. Results are paginated and every item has the same shape as in the other item endpoints, with all of its metadata."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
links:
first: 'https://garchi.co.uk/api/v2/items?page=1'
last: 'https://garchi.co.uk/api/v2/items?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
path: 'https://garchi.co.uk/api/v2/items'
per_page: 10
to: 1
total: 1
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
id: 11
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 11
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
links:
type: object
properties:
first:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
last:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
path:
type: string
example: 'https://garchi.co.uk/api/v2/items'
per_page:
type: integer
example: 10
to:
type: integer
example: 1
total:
type: integer
example: 1
404:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Space not found'
properties:
error:
type: string
example: 'Space not found'
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The op for "meta.color" must be one of: eq, ne, gt, gte, lt, lte, between, in, not_in, contains, starts_with, exists, not_exists, has_all.'
errors:
where.all.0.op:
- 'The op for "meta.color" must be one of: eq, ne, gt, gte, lt, lte, between, in, not_in, contains, starts_with, exists, not_exists, has_all.'
properties:
message:
type: string
example: 'The op for "meta.color" must be one of: eq, ne, gt, gte, lt, lte, between, in, not_in, contains, starts_with, exists, not_exists, has_all.'
errors:
type: object
properties:
where.all.0.op:
type: array
example:
- 'The op for "meta.color" must be one of: eq, ne, gt, gte, lt, lte, between, in, not_in, contains, starts_with, exists, not_exists, has_all.'
items:
type: string
tags:
- Item
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
where:
type: object
description: 'The filter: a condition, or a group {"all": [...]} / {"any": [...]}.'
example:
all:
-
field: meta.color
op: in
value:
- red
- blue
-
field: meta.specs.weight
op: lte
value: 2.5
-
any:
-
field: price
op: lt
value: 50
-
field: meta.on_sale
op: eq
value: true
properties: {}
sort:
type: array
description: 'Up to three fields to sort by.'
example:
-
field: meta.specs.weight
direction: asc
items:
type: object
properties:
field:
type: string
description: 'An item field or meta..'
example: price
direction:
type: string
description: 'asc or desc. Defaults to asc.'
example: asc
required:
- field
page:
type: integer
description: 'The page to return.'
example: 1
size:
type: integer
description: 'Items per page, up to 100. Defaults to 10.'
example: 10
reactions:
type: string
description: 'Include or exclude reactions for the items.'
example: exclude
children:
type: string
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
description:
type: string
description: 'Include or exclude the item description. Defaults to exclude.'
example: include
parameters:
-
in: path
name: uid
description: 'UID of the space.'
example: ca457162-6d04-4c3a-a3f6-2ab3e21b0fd00cca6914-5e72-4d54-b9db-fcf9
required: true
schema:
type: string
'/api/v2/space/{uid}/items/{item}/children':
get:
summary: 'List the items inside an item'
operationId: listTheItemsInsideAnItem
description: "Returns the published items inside an item, such as the variants of a product or the lessons of a course, in the order set in the dashboard. Each item has the same shape as in the other item endpoints, and its own `parent_id`.
\n\nItems can be nested up to three levels (Course → Module → Lesson); call this again with a child's id or slug to go one level deeper. The parent itself must be published, like every item the content API returns."
parameters:
-
in: query
name: page
description: 'The page to return.'
example: 1
required: false
schema:
type: integer
description: 'The page to return.'
example: 1
-
in: query
name: size
description: 'Items per page, up to 100. Defaults to 10.'
example: 10
required: false
schema:
type: integer
description: 'Items per page, up to 100. Defaults to 10.'
example: 10
-
in: query
name: reactions
description: 'Include or exclude reactions for the items.'
example: exclude
required: false
schema:
type: string
description: 'Include or exclude reactions for the items.'
example: exclude
-
in: query
name: children
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
required: false
schema:
type: string
description: 'Include the published items inside each item, in their order, one level deep. Defaults to exclude; every item always has children_count.'
example: exclude
-
in: query
name: description
description: 'Include or exclude the item description. Defaults to exclude.'
example: include
required: false
schema:
type: string
description: 'Include or exclude the item description. Defaults to exclude.'
example: include
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
links:
first: 'https://garchi.co.uk/api/v2/items?page=1'
last: 'https://garchi.co.uk/api/v2/items?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
path: 'https://garchi.co.uk/api/v2/items'
per_page: 10
to: 1
total: 1
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
id: 11
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 11
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
links:
type: object
properties:
first:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
last:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
path:
type: string
example: 'https://garchi.co.uk/api/v2/items'
per_page:
type: integer
example: 10
to:
type: integer
example: 1
total:
type: integer
example: 1
404:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Item not found'
properties:
error:
type: string
example: 'Item not found'
tags:
- Item
parameters:
-
in: path
name: uid
description: 'UID of the space.'
example: ca457162-6d04-4c3a-a3f6-2ab3e21b0fd00cca6914-5e72-4d54-b9db-fcf9
required: true
schema:
type: string
-
in: path
name: item
description: 'Id or slug of the parent item.'
example: oak-table
required: true
schema:
type: string
'/api/v2/space/assets/{name}':
get:
summary: 'Get asset file for a space'
operationId: getAssetFileForASpace
description: 'This api is used to get the asset (media file) for a space based on the name of the asset.'
parameters:
-
in: query
name: space_uid
description: 'Space uid.'
example: 635c09ed-d55f-407d-a4c0-45f5ad9f2b44c2321f02-a835-4024-9b83-c4a1
required: true
schema:
type: string
description: 'Space uid.'
example: 635c09ed-d55f-407d-a4c0-45f5ad9f2b44c2321f02-a835-4024-9b83-c4a1
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
asset_id: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
name: logo
path: 'https://assets.garchi.co.uk/headlessweb/11111111-1111-4111-8111-11111111111122222222-2222-4222-8222-222/logo-1700000000.jpg'
size: 157.08KB
type: uploaded-image
agent_description: 'This is agent description'
properties:
id:
type: string
example: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
asset_id:
type: string
example: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
name:
type: string
example: logo
path:
type: string
example: 'https://assets.garchi.co.uk/headlessweb/11111111-1111-4111-8111-11111111111122222222-2222-4222-8222-222/logo-1700000000.jpg'
size:
type: string
example: 157.08KB
type:
type: string
example: uploaded-image
agent_description:
type: string
example: 'This is agent description'
tags:
- 'Headless Web'
parameters:
-
in: path
name: name
description: 'Asset name.'
example: logo
required: true
schema:
type: string
/api/v2/page:
post:
summary: 'Get Page'
operationId: getPage
description: 'This api is used to get a page by slug and space_uid.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 55555555-5555-4555-8555-555555555555
title: Home
slug: /
description: 'a great space to be'
json_ld: '{"@context":"https://schema.org","@type":"WebPage","name":"Home"}'
agent_description: 'The home page. It introduces the brand and links to the main sections.'
image: 'https://assets.garchi.co.uk/headlesswebpages/33333333-3333-4333-8333-33333333333344444444-4444-4444-8444-444/some_file.png'
sections:
-
id: 99c21f3c-c434-4eb5-89ad-46e958a11081
name: Card
description: ''
agent_description: 'A card with a title, description and image.'
props:
title: 'This is great'
description: 'Thanks for telling this'
image: 'https://assets.garchi.co.uk/headlessweb/33333333-3333-4333-8333-33333333333344444444-4444-4444-8444-444/header-image-1700000001'
data-garchi-section-id: 99c21f3c-c434-4eb5-89ad-46e958a11081
data-garchi-page-id: 55555555-5555-4555-8555-555555555555
children: []
order: 0
-
id: 99c210e4-330d-458f-9af3-b5eea6af228d
name: Navbar
description: /components/Navbar
agent_description: null
props:
title: Home
link: 'https://google.com'
data-garchi-section-id: 99c210e4-330d-458f-9af3-b5eea6af228d
data-garchi-page-id: 55555555-5555-4555-8555-555555555555
children:
-
id: 99c3f4f6-7193-471e-a9c0-00ebca35811f
name: Logo
description: 'Main logo for the home page'
agent_description: null
props:
src: 'https://assets.garchi.co.uk/headlessweb/33333333-3333-4333-8333-33333333333344444444-4444-4444-8444-444/logo-1700000002'
data-garchi-section-id: 99c3f4f6-7193-471e-a9c0-00ebca35811f
data-garchi-page-id: 55555555-5555-4555-8555-555555555555
children: []
order: 0
order: 1
created_at: '2026-01-28T18:27:52.000000Z'
last_updated: '2026-01-28T18:27:52.000000Z'
properties:
id:
type: string
example: 55555555-5555-4555-8555-555555555555
title:
type: string
example: Home
slug:
type: string
example: /
description:
type: string
example: 'a great space to be'
json_ld:
type: string
example: '{"@context":"https://schema.org","@type":"WebPage","name":"Home"}'
agent_description:
type: string
example: 'The home page. It introduces the brand and links to the main sections.'
image:
type: string
example: 'https://assets.garchi.co.uk/headlesswebpages/33333333-3333-4333-8333-33333333333344444444-4444-4444-8444-444/some_file.png'
sections:
type: array
example:
-
id: 99c21f3c-c434-4eb5-89ad-46e958a11081
name: Card
description: ''
agent_description: 'A card with a title, description and image.'
props:
title: 'This is great'
description: 'Thanks for telling this'
image: 'https://assets.garchi.co.uk/headlessweb/33333333-3333-4333-8333-33333333333344444444-4444-4444-8444-444/header-image-1700000001'
data-garchi-section-id: 99c21f3c-c434-4eb5-89ad-46e958a11081
data-garchi-page-id: 55555555-5555-4555-8555-555555555555
children: []
order: 0
-
id: 99c210e4-330d-458f-9af3-b5eea6af228d
name: Navbar
description: /components/Navbar
agent_description: null
props:
title: Home
link: 'https://google.com'
data-garchi-section-id: 99c210e4-330d-458f-9af3-b5eea6af228d
data-garchi-page-id: 55555555-5555-4555-8555-555555555555
children:
-
id: 99c3f4f6-7193-471e-a9c0-00ebca35811f
name: Logo
description: 'Main logo for the home page'
agent_description: null
props:
src: 'https://assets.garchi.co.uk/headlessweb/33333333-3333-4333-8333-33333333333344444444-4444-4444-8444-444/logo-1700000002'
data-garchi-section-id: 99c3f4f6-7193-471e-a9c0-00ebca35811f
data-garchi-page-id: 55555555-5555-4555-8555-555555555555
children: []
order: 0
order: 1
items:
type: object
properties:
id:
type: string
example: 99c21f3c-c434-4eb5-89ad-46e958a11081
name:
type: string
example: Card
description:
type: string
example: ''
agent_description:
type: string
example: 'A card with a title, description and image.'
props:
type: object
properties:
title:
type: string
example: 'This is great'
description:
type: string
example: 'Thanks for telling this'
image:
type: string
example: 'https://assets.garchi.co.uk/headlessweb/33333333-3333-4333-8333-33333333333344444444-4444-4444-8444-444/header-image-1700000001'
data-garchi-section-id:
type: string
example: 99c21f3c-c434-4eb5-89ad-46e958a11081
data-garchi-page-id:
type: string
example: 55555555-5555-4555-8555-555555555555
children:
type: array
example: []
order:
type: integer
example: 0
created_at:
type: string
example: '2026-01-28T18:27:52.000000Z'
last_updated:
type: string
example: '2026-01-28T18:27:52.000000Z'
tags:
- 'Headless Web'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
space_uid:
type: string
description: 'UID of the space.'
example: 635c09ed-d55f-407d-a4c0-45f5ad9f2b44c2321f02-a835-4024-9b83-c4a1
slug:
type: string
description: 'Slug of the page.'
example: /
lang:
type: string
description: 'i-18n Language code of the page. Default value is en-US'
example: en-US
mode:
type: required
description: 'Mode of the page. Allowed values are draft, live.'
example: draft
required:
- space_uid
- slug
/api/v2/section_template:
post:
summary: 'Create or Update Section templates'
operationId: createOrUpdateSectionTemplates
description: 'This api is used to create or update section templates for a space. Section templates are used to create reusable sections on a page.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Section templates updated successfully'
properties:
message:
type: string
example: 'Section templates updated successfully'
tags:
- 'Headless Web'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
space_uid:
type: string
description: 'The unique identifier of the space.'
example: 5f0b3b2d-3b4e-4b6e-8b3e-3e3e3e3e3e3e
section_templates:
type: array
description: 'The section templates to be created or updated.'
example:
- []
items:
type: object
properties:
name:
type: string
description: 'The name of the section template.'
example: HeroSection
description:
type: string
description: 'The description of the section template.'
example: 'This is a hero section.'
prev_name:
type: string
description: 'The previous name of the section template. This is used when updating a section template.'
example: null
props:
type: array
description: 'The properties of the section template.'
example:
- []
items:
type: object
properties:
key:
type: string
description: 'The key of the property.'
example: icon
type:
type: string
description: 'The type of the property. Allowed values are text,longtext,media,richtext,select,icon_lucid,icon_hero,date'
example: select
allowed_values:
type: string
description: 'Comma separated allowed values for the prop. This is required if the type is select.'
example: 'CheckIcon,CheckCircleIcon'
required:
- key
- type
required:
- name
required:
- space_uid
- section_templates
/api/v2/page/add_blank_section:
post:
summary: 'Add blank section'
operationId: addBlankSection
description: 'This api is used to add a blank section to a page.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 019c0618-798d-731a-8a7b-9af92c98155d
name: TwoColumnWithImage
description: layout/TwoColumnWithImage
parent_id: null
order: 1
page_id: 019c0617-6ea4-72a5-9c97-4bffe1c4a2c9
section_template_id: 99999999-9999-4999-8999-999999999999
properties:
id:
type: string
example: 019c0618-798d-731a-8a7b-9af92c98155d
name:
type: string
example: TwoColumnWithImage
description:
type: string
example: layout/TwoColumnWithImage
parent_id:
type: string
example: null
nullable: true
order:
type: integer
example: 1
page_id:
type: string
example: 019c0617-6ea4-72a5-9c97-4bffe1c4a2c9
section_template_id:
type: string
example: 99999999-9999-4999-8999-999999999999
tags:
- 'Headless Web'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
page_id:
type: string
description: 'ID of the page.'
example: 019c05ef-4c27-719f-91b4-798de1d47a27
section_template_id:
type: string
description: 'ID of the section template.'
example: 99999999-9999-4999-8999-999999999999
parent_id:
type: string
description: 'nullable ID of the parent section if adding as a nested section to a section.'
example: 019c05f0-fe11-7252-acdf-b8b2de361841
required:
- page_id
- section_template_id
'/api/v2/space/{uid}/create_page':
post:
summary: 'Create Page'
operationId: createPage
description: 'This api is used to create a headless page in a space.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 019c05dc-a705-702b-a203-0017f28066a5
title: 'Example page'
slug: /example-page
description: 'This is an example page'
json_ld: null
agent_description: 'This is an example page'
image: null
sections: []
created_at: '2026-01-28T18:27:52.000000Z'
last_updated: '2026-01-28T18:27:52.000000Z'
properties:
id:
type: string
example: 019c05dc-a705-702b-a203-0017f28066a5
title:
type: string
example: 'Example page'
slug:
type: string
example: /example-page
description:
type: string
example: 'This is an example page'
json_ld:
type: string
example: null
nullable: true
agent_description:
type: string
example: 'This is an example page'
image:
type: string
example: null
nullable: true
sections:
type: array
example: []
created_at:
type: string
example: '2026-01-28T18:27:52.000000Z'
last_updated:
type: string
example: '2026-01-28T18:27:52.000000Z'
422:
description: 'Plan allowance reached'
content:
application/json:
schema:
type: object
example:
message: 'Page limit reached. This space has 3 of the 3 pages allowed per space on the Sandbox plan. Requests to add more will be refused until this space is below its limit of 3 pages.'
errors:
limit:
- 'Page limit reached. This space has 3 of the 3 pages allowed per space on the Sandbox plan. Requests to add more will be refused until this space is below its limit of 3 pages.'
plan_limit:
feature: pages
scope: space
period: null
unit: count
used: 3
limit: 3
plan: Sandbox
period_ends_on: null
starter_content_counts: false
properties:
message:
type: string
example: 'Page limit reached. This space has 3 of the 3 pages allowed per space on the Sandbox plan. Requests to add more will be refused until this space is below its limit of 3 pages.'
errors:
type: object
properties:
limit:
type: array
example:
- 'Page limit reached. This space has 3 of the 3 pages allowed per space on the Sandbox plan. Requests to add more will be refused until this space is below its limit of 3 pages.'
items:
type: string
plan_limit:
type: object
properties:
feature:
type: string
example: pages
scope:
type: string
example: space
period:
type: string
example: null
nullable: true
unit:
type: string
example: count
used:
type: integer
example: 3
limit:
type: integer
example: 3
plan:
type: string
example: Sandbox
period_ends_on:
type: string
example: null
nullable: true
starter_content_counts:
type: boolean
example: false
tags:
- 'Headless Web'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Title of the page.'
example: Home
description:
type: string
description: 'Description of the page.'
example: 'This is the home'
json_ld:
type: string
description: 'nullable JSON-LD structured data for SEO.'
example: labore
path:
type: string
description: 'Path of the page.'
example: /
agent_description:
type: string
description: 'AI-facing description of the page.'
example: 'This page introduces the brand and should help AI agents understand its purpose.'
required:
- title
- description
- path
parameters:
-
in: path
name: uid
description: 'UID of the space.'
example: 635c09ed-d55f-407d-a4c0-45f5ad9f2b44c2321f02-a835-4024-9b83-c4a1
required: true
schema:
type: string
'/api/v2/space/{uid}/pages':
get:
summary: 'List Pages'
operationId: listPages
description: 'This api is used to list pages in a space.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
example: 66666666-6666-4666-8666-666666666666
title:
type: string
example: Pricing
slug:
type: string
example: /pricing
description:
type: string
example: 'Generate amazing social media content from your video'
json_ld:
type: string
example: null
nullable: true
agent_description:
type: string
example: null
nullable: true
image:
type: string
example: null
nullable: true
sections:
type: array
example:
-
id: 77777777-7777-4777-8777-777777777777
page_id: 66666666-6666-4666-8666-666666666666
section_template_id: 99999999-9999-4999-8999-999999999999
parent_id: null
order: 0
createdBy: 186
lastUpdatedBy: 186
created_at: '2025-02-26T21:40:10.000000Z'
updated_at: '2025-02-26T21:40:10.000000Z'
deleted_at: null
items:
type: object
properties:
id:
type: string
example: 77777777-7777-4777-8777-777777777777
page_id:
type: string
example: 66666666-6666-4666-8666-666666666666
section_template_id:
type: string
example: 99999999-9999-4999-8999-999999999999
parent_id:
type: string
example: null
nullable: true
order:
type: integer
example: 0
createdBy:
type: integer
example: 186
lastUpdatedBy:
type: integer
example: 186
created_at:
type: string
example: '2025-02-26T21:40:10.000000Z'
updated_at:
type: string
example: '2025-02-26T21:40:10.000000Z'
deleted_at:
type: string
example: null
nullable: true
created_at:
type: string
example: '2025-02-26T21:39:49.000000Z'
last_updated:
type: string
example: '2025-07-25T19:08:57.000000Z'
example:
-
id: 66666666-6666-4666-8666-666666666666
title: Pricing
slug: /pricing
description: 'Generate amazing social media content from your video'
json_ld: null
agent_description: null
image: null
sections:
-
id: 77777777-7777-4777-8777-777777777777
page_id: 66666666-6666-4666-8666-666666666666
section_template_id: 99999999-9999-4999-8999-999999999999
parent_id: null
order: 0
createdBy: 186
lastUpdatedBy: 186
created_at: '2025-02-26T21:40:10.000000Z'
updated_at: '2025-02-26T21:40:10.000000Z'
deleted_at: null
created_at: '2025-02-26T21:39:49.000000Z'
last_updated: '2025-07-25T19:08:57.000000Z'
-
id: 88888888-8888-4888-8888-888888888888
title: 'Privacy policy'
slug: /privacy_policy
description: 'Privacy policy'
json_ld: null
agent_description: null
image: null
sections: []
created_at: '2025-02-26T21:39:49.000000Z'
last_updated: '2025-07-25T19:08:57.000000Z'
tags:
- 'Headless Web'
parameters:
-
in: path
name: uid
description: ''
example: commodi
required: true
schema:
type: string
'/api/v2/space/{uid}/section_templates':
get:
summary: 'List Section templates'
operationId: listSectionTemplates
description: 'This api is used to list section templates for a space. Section templates are used to create reusable sections on a page.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
example: TwoColumnWithImage
description:
type: string
example: layout/TwoColumnWithImage
agent_description:
type: string
example: null
nullable: true
prev_name:
type: string
example: ''
props:
type: array
example:
-
key: image
type: media
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000100
-
key: image_position
type: select
allowed_values: 'left,right'
id: 019c0618-0000-7000-8000-000000000101
-
key: description
type: richtext
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000102
-
key: is_video
type: select
allowed_values: 'yes,no'
id: 019c0618-0000-7000-8000-000000000103
-
key: title
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000104
-
key: cta_text_2
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000105
-
key: cta_link_2
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000106
-
key: cta_text
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000107
-
key: cta_link
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000108
items:
type: object
properties:
key:
type: string
example: image
type:
type: string
example: media
allowed_values:
type: string
example: ''
id:
type: string
example: 019c0618-0000-7000-8000-000000000100
id:
type: string
example: 99999999-9999-4999-8999-000000000001
example:
-
name: TwoColumnWithImage
description: layout/TwoColumnWithImage
agent_description: null
prev_name: ''
props:
-
key: image
type: media
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000100
-
key: image_position
type: select
allowed_values: 'left,right'
id: 019c0618-0000-7000-8000-000000000101
-
key: description
type: richtext
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000102
-
key: is_video
type: select
allowed_values: 'yes,no'
id: 019c0618-0000-7000-8000-000000000103
-
key: title
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000104
-
key: cta_text_2
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000105
-
key: cta_link_2
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000106
-
key: cta_text
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000107
-
key: cta_link
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000108
id: 99999999-9999-4999-8999-000000000001
-
name: FAQItem
description: ''
agent_description: null
prev_name: ''
props:
-
key: answer
type: longtext
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000200
-
key: question
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000201
id: 99999999-9999-4999-8999-000000000002
-
name: PricingCard
description: garchi/PricingCard
agent_description: null
prev_name: ''
props:
-
key: features
type: longtext
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000300
-
key: isFeatured
type: select
allowed_values: 'yes,no'
id: 019c0618-0000-7000-8000-000000000301
-
key: price
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000302
-
key: description
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000303
-
key: index
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000304
-
key: stripe_price_id
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000305
-
key: cta_text
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000306
-
key: name
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000307
id: 99999999-9999-4999-8999-000000000003
-
name: Markdown
description: Markdown
agent_description: null
prev_name: ''
props:
-
key: content
type: richtext
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000400
-
key: className
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000401
id: 99999999-9999-4999-8999-000000000004
-
name: Feature
description: garchi/Feature
agent_description: null
prev_name: ''
props:
-
key: icon
type: icon_lucid
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000500
-
key: title
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000501
-
key: description
type: longtext
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000502
id: 99999999-9999-4999-8999-000000000005
-
name: Features
description: garchi/Features
agent_description: null
prev_name: ''
props:
-
key: title
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000600
-
key: subtitle
type: longtext
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000601
id: 99999999-9999-4999-8999-000000000006
-
name: YoutubeVideo
description: garchi/YoutubeVideo
agent_description: null
prev_name: ''
props:
-
key: videoId
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000700
-
key: style
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000701
-
key: height
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000702
-
key: width
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000703
id: 99999999-9999-4999-8999-000000000007
-
name: Workflow
description: garchi/Workflow
agent_description: null
prev_name: ''
props:
-
key: description
type: longtext
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000800
-
key: title
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000801
-
key: cta_text
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000802
id: 99999999-9999-4999-8999-000000000008
-
name: CTA
description: garchi/CTA
agent_description: null
prev_name: ''
props:
-
key: ctaLink
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000900
-
key: title
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000901
-
key: description
type: longtext
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000902
-
key: ctaText
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000000903
id: 99999999-9999-4999-8999-000000000009
-
name: Hero
description: garchi/Hero
agent_description: null
prev_name: ''
props:
-
key: words
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000001000
-
key: description
type: longtext
allowed_values: ''
id: 019c0618-0000-7000-8000-000000001001
-
key: ctaLink
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000001002
-
key: title
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000001003
-
key: ctaText
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000001004
id: 99999999-9999-4999-8999-000000000010
-
name: FAQ
description: ui/faq
agent_description: null
prev_name: ''
props: []
id: 99999999-9999-4999-8999-000000000011
-
name: Pricing
description: garchi/Pricing
agent_description: null
prev_name: ''
props:
-
key: title
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000001200
-
key: subheading
type: text
allowed_values: ''
id: 019c0618-0000-7000-8000-000000001201
id: 99999999-9999-4999-8999-000000000012
tags:
- 'Headless Web'
parameters:
-
in: path
name: uid
description: 'The unique identifier of the space.'
example: 5f0b3b2d-3b4e-4b6e-8b3e-3e3e3e3e3e3e
required: true
schema:
type: string
/api/v2/reviews/item:
post:
summary: 'Create new review for the item'
operationId: createNewReviewForTheItem
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
review_id: 15
review_body: 'This is a best selling item'
rating: 4
user:
name: Jane
email: jane.doe@example.com
item_id: 15
reviewed_at: '2022-02-23T23:00:45.000000Z'
parent: null
properties:
data:
type: object
properties:
review_id:
type: integer
example: 15
review_body:
type: string
example: 'This is a best selling item'
rating:
type: integer
example: 4
user:
type: object
properties:
name:
type: string
example: Jane
email:
type: string
example: jane.doe@example.com
item_id:
type: integer
example: 15
reviewed_at:
type: string
example: '2022-02-23T23:00:45.000000Z'
parent:
type: string
example: null
nullable: true
tags:
- Reviews
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
item_id:
type: integer
description: 'id of the item.'
example: 4
rating:
type: integer
description: 'Number of stars or rating. Ranging from 1-5.'
example: 4
review_body:
type: string
description: 'Review body. Max 5000 characters.'
example: 'This is a best selling item.'
user_email:
type: string
description: 'Email of the reviewer if the reviewer is authenticated using your or third party services like firebase, supabase etc.'
example: jane.doe@example.com
user_name:
type: string
description: 'Name of the reviewer if the reviewer is authenticated using your or third party services like firebase, supabase etc.'
example: Jane
parent_id:
type: integer
description: 'Id of the parent review.'
example: 4
required:
- item_id
- rating
/api/v2/reviews/edit:
post:
summary: 'Edit a review'
operationId: editAReview
description: 'Edits a review. Only provided fields will be updated rest will be ignored.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: '1 reviews updated'
properties:
message:
type: string
example: '1 reviews updated'
tags:
- Reviews
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
review_id:
type: integer
description: 'Id of the review.'
example: 4
review_body:
type: string
description: 'Review body. Max 5000 characters.'
example: 'This is an amazing seller.'
rating:
type: integer
description: 'Number of stars or rating. Ranging from 1-5.'
example: 4
required:
- review_id
- rating
/api/v2/reviews/delete:
post:
summary: 'Delete a review'
operationId: deleteAReview
description: 'Permenantly deletes a specific review.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: '1 reviews deleted'
properties:
message:
type: string
example: '1 reviews deleted'
tags:
- Reviews
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
review_id:
type: integer
description: 'ID of the review'
example: 16
required:
- review_id
'/api/v2/reviews/item/{item}':
get:
summary: 'Get reviews for an item'
operationId: getReviewsForAnItem
description: 'Returns the reviews for an item'
parameters:
-
in: query
name: size
description: 'Number of reviews per page. Default is set to 5.'
example: 10
required: false
schema:
type: integer
description: 'Number of reviews per page. Default is set to 5.'
example: 10
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
review_id: 15
review_body: 'This is a best selling item'
rating: 4
user:
name: Jane
email: jane.doe@example.com
item_id: 15
reviewed_at: '2022-02-23T23:00:45.000000Z'
parent: null
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
replies:
-
review_id: 16
review_body: 'Thanks for the feedback!'
rating: 5
user:
name: 'Garchi Support'
email: support@example.com
item_id: 15
reviewed_at: '2022-02-24T09:12:10.000000Z'
parent: 15
reactions: []
replies: []
links:
first: 'https://garchi.co.uk/api/v2/reviews/item/15?page=1'
last: 'https://garchi.co.uk/api/v2/reviews/item/15?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/reviews/item/15?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
path: 'https://garchi.co.uk/api/v2/reviews/item/15'
per_page: 5
to: 1
total: 1
properties:
data:
type: array
example:
-
review_id: 15
review_body: 'This is a best selling item'
rating: 4
user:
name: Jane
email: jane.doe@example.com
item_id: 15
reviewed_at: '2022-02-23T23:00:45.000000Z'
parent: null
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
replies:
-
review_id: 16
review_body: 'Thanks for the feedback!'
rating: 5
user:
name: 'Garchi Support'
email: support@example.com
item_id: 15
reviewed_at: '2022-02-24T09:12:10.000000Z'
parent: 15
reactions: []
replies: []
items:
type: object
properties:
review_id:
type: integer
example: 15
review_body:
type: string
example: 'This is a best selling item'
rating:
type: integer
example: 4
user:
type: object
properties:
name:
type: string
example: Jane
email:
type: string
example: jane.doe@example.com
item_id:
type: integer
example: 15
reviewed_at:
type: string
example: '2022-02-23T23:00:45.000000Z'
parent:
type: string
example: null
nullable: true
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
replies:
type: array
example:
-
review_id: 16
review_body: 'Thanks for the feedback!'
rating: 5
user:
name: 'Garchi Support'
email: support@example.com
item_id: 15
reviewed_at: '2022-02-24T09:12:10.000000Z'
parent: 15
reactions: []
replies: []
items:
type: object
properties:
review_id:
type: integer
example: 16
review_body:
type: string
example: 'Thanks for the feedback!'
rating:
type: integer
example: 5
user:
type: object
properties:
name:
type: string
example: 'Garchi Support'
email:
type: string
example: support@example.com
item_id:
type: integer
example: 15
reviewed_at:
type: string
example: '2022-02-24T09:12:10.000000Z'
parent:
type: integer
example: 15
reactions:
type: array
example: []
replies:
type: array
example: []
links:
type: object
properties:
first:
type: string
example: 'https://garchi.co.uk/api/v2/reviews/item/15?page=1'
last:
type: string
example: 'https://garchi.co.uk/api/v2/reviews/item/15?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/reviews/item/15?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
path:
type: string
example: 'https://garchi.co.uk/api/v2/reviews/item/15'
per_page:
type: integer
example: 5
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- Reviews
parameters:
-
in: path
name: item
description: 'ID of the item'
example: '15'
required: true
schema:
type: string
/api/v2/compound_query:
post:
summary: 'Compound Query'
operationId: compoundQuery
description: "Compound query is useful when you want to fetch data using complex filters. It is advisable to use compound query only in limited cases as it involves querying using multiple conditions which can be slow.
\n\nYou need to provide the dataset to query, the fields to query, the conditions for the fields, the values for the conditions and the logic whether to perform logical and/or of the conditions.
\n\nField restriction varies based on the dataset.
\n\nAllowed fields for items [item_id, name, slug, description, categories, ratings, price, created, published]
\n\nAllowed fields for categories [category_id, category_name]
\n\nAllowed fields for reviews [review_id, item_id, rating, review, created]
\n\nYou can have duplicate fields in the fields array.
\n\nThe response schema depends on the dataset. Depending on the dataset the response schema will be as follows:
\n\nitems: list all items api .
\nreviews: get reviews for an item api .
\ncategories: get all categories api .
"
parameters:
-
in: query
name: order_key
description: 'string. Key to order the dataset by. Allowed values are any field allowed for that respective dataset.'
example: created
required: false
schema:
type: string
description: 'string. Key to order the dataset by. Allowed values are any field allowed for that respective dataset.'
example: created
-
in: query
name: order_by
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
required: false
schema:
type: string
description: 'string. Order by ascending or descending. Allowed values are asc, desc.'
example: desc
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
links:
first: 'https://garchi.co.uk/api/v2/items?page=1'
last: 'https://garchi.co.uk/api/v2/items?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
path: 'https://garchi.co.uk/api/v2/items'
per_page: 10
to: 1
total: 1
properties:
data:
type: array
example:
-
item_id: 26
sku: WD-101
external_link: ''
slug: example-product
parent_id: null
children_count: 0
name: 'Example Product'
stock: 100
price: 40
scratched_price: null
one_liner: 'Best book for beginners'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
delivery_type: can_deliver
main_image: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: Books
avg_rating: null
scheduled_for: null
item_meta:
-
id: 11
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
agent_description: 'A beginner-friendly book that teaches web development step by step.'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
items:
type: object
properties:
item_id:
type: integer
example: 26
sku:
type: string
example: WD-101
external_link:
type: string
example: ''
slug:
type: string
example: example-product
parent_id:
type: string
example: null
nullable: true
children_count:
type: integer
example: 0
name:
type: string
example: 'Example Product'
stock:
type: integer
example: 100
price:
type: integer
example: 40
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for beginners'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
rank: null
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
rank:
type: string
example: null
nullable: true
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://assets.garchi.co.uk/examples/product-main.png'
other_images:
type: array
example:
- 'https://assets.garchi.co.uk/examples/product-1.png'
- 'https://assets.garchi.co.uk/examples/product-2.png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 16
name:
type: string
example: 'Book Cover'
min:
type: string
example: '1'
options:
type: array
example:
-
id: 29
sku: WD-101-PAPER
name: Paper
price: 0.5
-
id: 30
sku: WD-101-BOUND
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
sku:
type: string
example: WD-101-PAPER
name:
type: string
example: Paper
price:
type: number
example: 0.5
space:
type: object
properties:
uid:
type: string
example: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name:
type: string
example: Books
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
id: 11
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
id:
type: integer
example: 11
key:
type: string
example: website
value:
type: string
example: 'https://example.com'
type:
type: string
example: url
reactions:
type: array
example:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
items:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
agent_description:
type: string
example: 'A beginner-friendly book that teaches web development step by step.'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
links:
type: object
properties:
first:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
last:
type: string
example: 'https://garchi.co.uk/api/v2/items?page=1'
prev:
type: string
example: null
nullable: true
next:
type: string
example: null
nullable: true
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
links:
type: array
example:
-
url: null
label: '« Previous'
active: false
-
url: 'https://garchi.co.uk/api/v2/items?page=1'
label: '1'
active: true
-
url: null
label: 'Next »'
active: false
items:
type: object
properties:
url:
type: string
example: null
nullable: true
label:
type: string
example: '« Previous'
active:
type: boolean
example: false
path:
type: string
example: 'https://garchi.co.uk/api/v2/items'
per_page:
type: integer
example: 10
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'Compound Query'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
dataset:
type: string
description: 'required. The dataset to query. Allowed values are items, categories, reviews.'
example: items
fields:
type: array
description: 'required. The fields for condition. The sequence matters.'
example:
- name
- price
items:
type: string
conditions:
type: array
description: 'required. The conditions for the fields. The sequence matters. Allowed conditions eq,gte,lte,gt,lt,like,in,not_eq,not_in.'
example:
- eq
- lte
items:
type: string
values:
type: array
description: 'required. The values for the conditions. The sequence matters.'
example:
- Apple
- 100
items:
type: string
logic:
type: 'string[].'
description: 'The logic to use for the conditions. The sequence matters. Allowed values are and, or.'
example: '["and"]'
/api/v2/manage-reaction:
post:
summary: 'Mark a reaction'
operationId: markAReaction
description: 'Creates a reaction for review, item. If the reaction already exists it will be deleted and a new one will be added.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Existing reaction removed'
type: object
example:
message: 'Reaction deleted'
properties:
message:
type: string
example: 'Reaction deleted'
-
description: ''
type: object
example:
data:
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: jane.doe@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
properties:
data:
type: object
properties:
reaction_id:
type: string
example: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction:
type: string
example: like
user_identifier:
type: string
example: jane.doe@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
tags:
- Reaction
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
reaction:
type: string
description: 'Reaction type.'
example: like
user_identifier:
type: string
description: 'User identifier Could be email or uid.'
example: jane.doe@example.com
review_id:
type: integer
description: 'Only required if reaction for review.'
example: 4
item_id:
type: integer
description: 'Only required if reaction for an item.'
example: 4
reaction_for:
type: string
description: 'Allowed values are review, item.'
example: review
required:
- reaction
- user_identifier
- reaction_for