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: Customer
description: ''
-
name: Orders
description: ''
-
name: Category
description: ''
-
name: Item
description: ''
-
name: Reviews
description: ''
-
name: Spaces
description: ''
-
name: 'Compound Query'
description: ''
-
name: 'Headless Web'
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/register:
post:
summary: 'Register a customer'
operationId: registerACustomer
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
firstname: Aditya
lastname: Kadam
email: aditya@example.com
contact: '0123092312312'
uid: 'uid string'
email_verified: null
properties:
data:
type: object
properties:
firstname:
type: string
example: Aditya
lastname:
type: string
example: Kadam
email:
type: string
example: aditya@example.com
contact:
type: string
example: '0123092312312'
uid:
type: string
example: 'uid string'
email_verified:
type: string
example: null
nullable: true
tags:
- Customer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
firstname:
type: string
description: ''
example: Aditya
lastname:
type: string
description: ''
example: Kadam
email:
type: string
description: ''
example: aditya@example.com
password:
type: string
description: ''
example: Str0ngPa$$word
password_confirmation:
type: string
description: 'Confirmed Password of the user.'
example: Str0ngPa$$word
contact:
type: string
description: ''
example: '0123092312312'
cannotify:
type: boolean.
description: 'Whether the user has given permission for notification to you.'
example: 'true'
required:
- firstname
- lastname
- email
- password
- password_confirmation
security: []
/api/v2/login:
post:
summary: 'Login a customer'
operationId: loginACustomer
description: 'Takes in email and password. On success returns the user details.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
firstname: Aditya
lastname: Kadam
email: aditya@example.com
contact: '0123092312312'
uid: 'uid string'
email_verified: null
properties:
data:
type: object
properties:
firstname:
type: string
example: Aditya
lastname:
type: string
example: Kadam
email:
type: string
example: aditya@example.com
contact:
type: string
example: '0123092312312'
uid:
type: string
example: 'uid string'
email_verified:
type: string
example: null
nullable: true
tags:
- Customer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: ''
example: aditya@example.com
password:
type: string
description: ''
example: Str0ngPa$$word
required:
- email
- password
security: []
/api/v2/markemailverified:
post:
summary: 'Mark Email as Verified'
operationId: markEmailAsVerified
description: "Need to pass the uid of the person after the email is verified. Make sure that the email verification complete process has to be carried out by you.\nAfter making the request this api will simply set the timestamp of the request in the email_verified field"
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
firstname: Aditya
lastname: Kadam
email: aditya@example.com
contact: '0123092312312'
uid: 'uid string'
email_verified: null
properties:
data:
type: object
properties:
firstname:
type: string
example: Aditya
lastname:
type: string
example: Kadam
email:
type: string
example: aditya@example.com
contact:
type: string
example: '0123092312312'
uid:
type: string
example: 'uid string'
email_verified:
type: string
example: null
nullable: true
tags:
- Customer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
uid:
type: string
description: 'uid of the user whose email is already verified by you.'
example: 73110a91-385c-453a-96b4-a482ff7e1e3b2b2a3289-47be-438a-a102-b07314d619516927b77d-e70a-40d9-8df8-2230621c53d5a5ca4a10-8917-430d-a
required:
- uid
security: []
/api/v2/customer/changepassword:
post:
summary: 'Password Reset'
operationId: passwordReset
description: "Need to pass in the uid of the user, and the new_password with confirmation.\nThis API assumes that you have validated the password reset request of the user either by sending password reset link to their email or via some other secure method.\n\nPassword should be a plain text. It will be hashed before storing."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
firstname: Aditya
lastname: Kadam
email: aditya@example.com
contact: '1310003912322'
uid: 'uid string'
email_verified: null
properties:
data:
type: object
properties:
firstname:
type: string
example: Aditya
lastname:
type: string
example: Kadam
email:
type: string
example: aditya@example.com
contact:
type: string
example: '1310003912322'
uid:
type: string
example: 'uid string'
email_verified:
type: string
example: null
nullable: true
tags:
- Customer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
uid:
type: string
description: 'uid of the user.'
example: 73110a91-385c-453a-96b4-a482ff7e1e3b2b2a3289-47be-438a-a102-b07314d619516927b77d-e70a-40d9-8df8-2230621c53d5a5ca4a10-8917-430d-a
new_password:
type: string
description: ''
example: NewStr0ngestPa$$word
new_password_confirmation:
type: string
description: ''
example: NewStr0ngestPa$$word
required:
- uid
- new_password
- new_password_confirmation
security: []
/api/v2/customer/update:
post:
summary: 'Update customer details'
operationId: updateCustomerDetails
description: 'Updates details of the customers. Only provided fields will be updated rest will be kept as it is.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
firstname: Aditya
lastname: Kadam
email: aditya@example.com
contact: '1310003912322'
uid: 'uid string'
email_verified: null
properties:
data:
type: object
properties:
firstname:
type: string
example: Aditya
lastname:
type: string
example: Kadam
email:
type: string
example: aditya@example.com
contact:
type: string
example: '1310003912322'
uid:
type: string
example: 'uid string'
email_verified:
type: string
example: null
nullable: true
tags:
- Customer
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
firstname:
type: string
description: ''
example: Aditya
lastname:
type: string
description: ''
example: Kadam
email:
type: string
description: ''
example: aditya@example.com
uid:
type: string
description: 'uid of the user.'
example: 73110a91-385c-453a-96b4-a482ff7e1e3b2b2a3289-47be-438a-a102-b07314d619516927b77d-e70a-40d9-8df8-2230621c53d5a5ca4a10-8917-430d-a
contact:
type: string
description: ''
example: '1310003912322'
notifyme:
type: boolean
description: 'required. Whether the user has given permission for notification to you.'
example: true
required:
- firstname
- lastname
- email
- uid
security: []
/api/v2/customers:
get:
summary: 'List Customers'
operationId: listCustomers
description: 'Returns the list of registered customers. You can pass the filter like email to get the single customer details.'
parameters:
-
in: query
name: email
description: 'email of the user.'
example: aditya@example.com
required: false
schema:
type: string
description: 'email of the user.'
example: aditya@example.com
-
in: query
name: size
description: 'results per page. Default is 50'
example: 50
required: false
schema:
type: integer
description: 'results per page. Default is 50'
example: 50
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\n\"data\": [\n {\n \"firstname\": \"Aditya\",\n \"lastname\": \"Kadam\",\n \"email\": \"aditya@example.com\",\n \"contact\": \"07948048596\",\n \"uid\": \"de3523f0-9661-4d94-b0d7-04b4a31c06663cb128d0-296d-430b-adfa-badeee6a51935971fc62-2425-4e40-a425-c46008d4f16f3d494fca-46d9-4be6-8\",\n \"email_verified\": \"2021-04-18 20:27:35\"\n },\n],\n\"links\": {\n \"first\": \"https://garchi.co.uk/api/v2/customers?page=1\",\n \"last\": \"https://garchi.co.uk/api/v2/customers?page=1\",\n \"prev\": null,\n \"next\": null\n},\n\"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://garchi.co.uk/api/v2/customers?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://garchi.co.uk/api/v2/customers\",\n \"per_page\": 50,\n \"to\": 1,\n \"total\": 1\n}\n\n}"
tags:
- Customer
security: []
'/api/v2/customer/{uid}':
get:
summary: 'Return a single customer details'
operationId: returnASingleCustomerDetails
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
firstname: Aditya
lastname: Kadam
email: aditya@example.com
contact: '0123092312312'
uid: 'uid string'
email_verified: null
properties:
data:
type: object
properties:
firstname:
type: string
example: Aditya
lastname:
type: string
example: Kadam
email:
type: string
example: aditya@example.com
contact:
type: string
example: '0123092312312'
uid:
type: string
example: 'uid string'
email_verified:
type: string
example: null
nullable: true
tags:
- Customer
security: []
parameters:
-
in: path
name: uid
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 73110a91-385c-453a-96b4-a482ff7e1e3b2b2a3289-47be-438a-a102-b07314d619516927b77d-e70a-40d9-8df8-2230621c53d5a5ca4a10-8917-430d-a
/api/v2/order/create:
post:
summary: 'Create an Order'
operationId: createAnOrder
description: "Creates new order for a customer. Make sure to call this api after successful payment transaction.You need to handle payment from your side. You can pass the\npayment_id and the payment_method (eg: stripe) as a part of request body for transaction records."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
invoiceNumber: bd402d30-9810-43b3-8c98-3f1c0208c098
payload:
cart_items:
-
item_id: 2
item_name: 'Web Dev Book'
quantity: 2
delivery_date: '2022-12-12'
attributes:
-
attribute_name: Date
selected_options:
-
subattr: '21st March'
price: '1'
subattr_id: '3'
sub_total_amount: 80
tax_amount: 10
shipping_amount: 5
customer_uid: null
coupon_code: null
coupon_id: null
discount_value: null
guest_name: aditya
guest_email: aditya@example.com
guest_contact: '1234567890'
delivery_address: 'Street 1, XYZ Road, London, LLL 111'
payment_id: pi_1IglpAJBBrYOr00bW4tJ312
payment_provider: stripe
properties:
invoiceNumber:
type: string
example: bd402d30-9810-43b3-8c98-3f1c0208c098
payload:
type: object
properties:
cart_items:
type: array
example:
-
item_id: 2
item_name: 'Web Dev Book'
quantity: 2
delivery_date: '2022-12-12'
attributes:
-
attribute_name: Date
selected_options:
-
subattr: '21st March'
price: '1'
subattr_id: '3'
items:
type: object
properties:
item_id:
type: integer
example: 2
item_name:
type: string
example: 'Web Dev Book'
quantity:
type: integer
example: 2
delivery_date:
type: string
example: '2022-12-12'
attributes:
type: array
example:
-
attribute_name: Date
selected_options:
-
subattr: '21st March'
price: '1'
subattr_id: '3'
items:
type: object
properties:
attribute_name:
type: string
example: Date
selected_options:
type: array
example:
- { subattr: '21st March', price: '1', subattr_id: '3' }
items:
type: object
properties: { subattr: { type: string, example: '21st March' }, price: { type: string, example: '1' }, subattr_id: { type: string, example: '3' } }
sub_total_amount:
type: integer
example: 80
tax_amount:
type: integer
example: 10
shipping_amount:
type: integer
example: 5
customer_uid:
type: string
example: null
nullable: true
coupon_code:
type: string
example: null
nullable: true
coupon_id:
type: string
example: null
nullable: true
discount_value:
type: string
example: null
nullable: true
guest_name:
type: string
example: aditya
guest_email:
type: string
example: aditya@example.com
guest_contact:
type: string
example: '1234567890'
delivery_address:
type: string
example: 'Street 1, XYZ Road, London, LLL 111'
payment_id:
type: string
example: pi_1IglpAJBBrYOr00bW4tJ312
payment_provider:
type: string
example: stripe
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cart_items:
type: array
description: 'Cart items array.'
example:
- []
items:
type: object
properties:
item_id:
type: integer
description: 'Id of the item.'
example: 2
item_name:
type: string
description: 'Name of the item.'
example: 'Web Dev Book'
quantity:
type: integer
description: 'Quantity of item added.'
example: 2
delivery_date:
type: date
description: 'Delivery date for the item.'
example: '2022-12-12'
attributes:
type: array
description: "Attributes selected for a item. This needs to be in specific format. The correct format is [{attribute_name: 'main_attribute_name', selected_options: [{subattr:\"selected option\", price: \"option price\", subattr_id:'option_id'}]']."
example:
- []
items:
type: object
properties:
attribute_name:
type: string
description: 'Name of the attribute.'
example: Date
selected_options:
type: array
description: 'Array of selected options for a attribute'
example:
- []
items:
type: object
properties:
subattr:
type: string
description: 'Name of selected option.'
example: '21st March'
price:
type: number
description: 'price of the selected option.'
example: 1.0
subattr_id:
type: integer
description: 'id of selected option.'
example: 3
required:
- item_id
- item_name
- quantity
shipping_amount:
type: number
description: 'shipping cost.'
example: 5.0
sub_total_amount:
type: number
description: 'Cart sub total excluding the discount price. This is the on which discount will be calculated.'
example: 80.0
tax_amount:
type: number
description: 'tax amount.'
example: 10.0
customer_uid:
type: string
description: 'uid of the customer if you are using login api. Keep blank if you are using other authentication method (like firebase) or guest checkout.'
example: 73110a91-385c-453a-96b4-a482ff7e1e3b2b2a3289-47be-438a-a102-b07314d619516927b77d-e70a-40d9-8df8-2230621c53d5a5ca4a10-8917-430d-a
coupon_code:
type: string
description: 'Coupon code if the coupon was used. Make sure to validate the coupon before creating order.'
example: AK123
coupon_id:
type: integer
description: 'id of the coupon recieved in the response of validate-coupon api.'
example: 2
discount_value:
type: number
description: 'discount amount for the coupon recieved in the response of validate-coupon api.'
example: 12.0
guest_name:
type: string
description: 'If you choose to use other authentication method (firebase or guest checkout) then full name of the user.'
example: keep_blank_if_using_login_api_else_provide_user_full_name
guest_email:
type: string
description: 'If you choose to use other authentication method (firebase or guest checkout) then email name of the user.'
example: keep_blank_if_using_login_api_else_provide_user_email
guest_contact:
type: string
description: 'If you choose to use other authentication method (firebase or guest checkout) then contact number of the user.'
example: keep_blank_if_using_login_api_else_provide_user_contact
delivery_address:
type: string
description: 'Delivery address provided by the user.'
example: 'Street 1, XYZ Road, London, LLL 111'
payment_id:
type: string
description: 'Payment id after successful payment that will help you to keep track of payments.'
example: pi_1IglpAJBBrYOr00bW4tJ312
payment_provider:
type: string
description: 'Payment provider used. Accepted values stripe, paypal, razorpay, other.'
example: stripe
required:
- cart_items
- sub_total_amount
- delivery_address
security: []
/api/v2/order/markasrefunded:
post:
summary: 'Mark as refunded for an item ordered'
operationId: markAsRefundedForAnItemOrdered
description: 'Changes an ordered item status to refunded.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Item order was marked as refunded'
properties:
message:
type: string
example: 'Item order was marked as refunded'
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
line_item_id:
type: integer
description: 'ordered item id which is different from product id.'
example: 30
invoice_number:
type: string
description: 'Invoice number.'
example: bd402d30-9810-43b3-8c98-3f1c0208c098
required:
- line_item_id
- invoice_number
security: []
/api/v2/order/markascancel:
post:
summary: 'Mark as cancel for an item ordered'
operationId: markAsCancelForAnItemOrdered
description: 'Changes an ordered item status to cancelled.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Item order cancelled'
properties:
message:
type: string
example: 'Item order cancelled'
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
line_item_id:
type: integer
description: 'ordered item id which is different from product id.'
example: 30
invoice_number:
type: string
description: 'Invoice number.'
example: bd402d30-9810-43b3-8c98-3f1c0208c098
required:
- line_item_id
- invoice_number
security: []
/api/v2/orders/markascancel:
post:
summary: 'Mark the entire order as cancelled'
operationId: markTheEntireOrderAsCancelled
description: 'Marks the entire order status and the line items order status as cancelled.'
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n message: The order with bd402d30-9810-43b3-8c98-3f1c0208c098 was cancelled successfully\n}"
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
invoice_number:
type: string
description: 'Invoice number.'
example: bd402d30-9810-43b3-8c98-3f1c0208c098
required:
- invoice_number
security: []
/api/v2/orders/markasrefund:
post:
summary: 'Mark entire order as refunded'
operationId: markEntireOrderAsRefunded
description: 'This is api is used to change status of the entire order/all the ordered items status to refunded'
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n message: The complete order with bd402d30-9810-43b3-8c98-3f1c0208c098 was marked as refunded successfully\n}"
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
invoice_number:
type: string
description: 'Invoice number.'
example: bd402d30-9810-43b3-8c98-3f1c0208c098
required:
- invoice_number
security: []
/api/v2/orders/guest:
post:
summary: 'List all orders for guest customer'
operationId: listAllOrdersForGuestCustomer
description: "This api lists all the orders for a customer that you registered/created using third party resources like Firebase Auth, etc.\nIf you are using register api then see this section"
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": [\n{\n \"invoice\": \"64ba7caf-e18d-40f8-b7bd-3ea291501618\",\n \"sub_total_amount\": 80,\n \"tax_amount\": null,\n \"shipping_amount\": 5,\n \"payment_transaction\": {\n \"payment_id\": \"pi_1IglpAJBBrYOr00bW4tJ312\",\n \"refunded\": false,\n \"payment_provider\": \"stripe\",\n \"created_at\": \"2022-04-16T11:19:25.000000Z\",\n \"last_updated\": \"2022-04-16T11:19:25.000000Z\"\n },\n \"line_items\": [\n {\n \"line_item_id\": 38,\n \"delivery_address\": \"Street 1, XYZ Road, London, LLL 111\",\n \"quantity\": 2,\n \"options\": null,\n \"price\": 0,\n \"delivery_dt\": \"2022-12-12\",\n \"status\": \"placed\",\n \"placed_at\": \"2022-04-16T11:19:25.000000Z\",\n \"items\": {\n \"item_id\": 15,\n \"sku\": \"SKU123123123\",\n \"slug\": \"Web-app-with-Vue-3-and-Tailwind-CSS\",\n \"name\": \"Web app with Vue 3 and Tailwind CSS\",\n \"price\": 40,\n \"space\": {\n \"name\": \"Space 1\"\n }\n }\n },\n ]\n }\n]\n}"
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
guest_email:
type: string
description: 'Email address of the registered user.'
example: lamont83@example.org
required:
- guest_email
security: []
/api/v2/orders/guest/update:
post:
summary: 'Change guest user details'
operationId: changeGuestUserDetails
description: "If you are not using login api for authenticating the user or\nif you are using third party authentication like Firebase or if you are handling the authentication by yourself\nthen this api might be handy to keep the user record updated."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Details updated successfully'
properties:
message:
type: string
example: 'Details updated successfully'
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
guest_email:
type: string
description: 'Email of the user'
example: aditya@example.com
guest_contact:
type: string
description: 'Phone number of the user'
example: '111111111'
required:
- guest_email
security: []
'/api/v2/orders/{uid}':
get:
summary: 'List all orders for registered customer'
operationId: listAllOrdersForRegisteredCustomer
description: 'List order details for a registered customer. This API works for customers registered using Register API.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
invoice: 64ba7caf-e18d-40f8-b7bd-3ea291501618
sub_total_amount: 80
tax_amount: null
shipping_amount: 5
payment_transaction:
payment_id: pi_1IglpAJBBrYOr00bW4tJ312
refunded: false
payment_provider: stripe
created_at: '2022-04-16T11:19:25.000000Z'
last_updated: '2022-04-16T11:19:25.000000Z'
line_items:
-
line_item_id: 38
delivery_address: 'Street 1, XYZ Road, London, LLL 111'
quantity: 2
options: null
price: 0
delivery_dt: '2022-12-12'
status: placed
placed_at: '2022-04-16T11:19:25.000000Z'
items:
item_id: 15
sku: SKU123123123
external_link: ''
slug: Web-app-with-Vue-3-and-Tailwind-CSS
name: 'Web app with Vue 3 and Tailwind CSS'
price: 40
space:
name: 'Space 1'
-
line_item_id: 39
delivery_address: 'Street 1, XYZ Road, London, LLL 111'
quantity: 2
options: null
price: 0
delivery_dt: '2022-12-12'
status: placed
placed_at: '2022-04-16T11:19:25.000000Z'
items:
item_id: 16
external_link: ''
sku: null
slug: null
name: 'Designing with Canva '
price: 15.99
space:
name: 'Space 2'
properties:
data:
type: array
example:
-
invoice: 64ba7caf-e18d-40f8-b7bd-3ea291501618
sub_total_amount: 80
tax_amount: null
shipping_amount: 5
payment_transaction:
payment_id: pi_1IglpAJBBrYOr00bW4tJ312
refunded: false
payment_provider: stripe
created_at: '2022-04-16T11:19:25.000000Z'
last_updated: '2022-04-16T11:19:25.000000Z'
line_items:
-
line_item_id: 38
delivery_address: 'Street 1, XYZ Road, London, LLL 111'
quantity: 2
options: null
price: 0
delivery_dt: '2022-12-12'
status: placed
placed_at: '2022-04-16T11:19:25.000000Z'
items:
item_id: 15
sku: SKU123123123
external_link: ''
slug: Web-app-with-Vue-3-and-Tailwind-CSS
name: 'Web app with Vue 3 and Tailwind CSS'
price: 40
space:
name: 'Space 1'
-
line_item_id: 39
delivery_address: 'Street 1, XYZ Road, London, LLL 111'
quantity: 2
options: null
price: 0
delivery_dt: '2022-12-12'
status: placed
placed_at: '2022-04-16T11:19:25.000000Z'
items:
item_id: 16
external_link: ''
sku: null
slug: null
name: 'Designing with Canva '
price: 15.99
space:
name: 'Space 2'
items:
type: object
properties:
invoice:
type: string
example: 64ba7caf-e18d-40f8-b7bd-3ea291501618
sub_total_amount:
type: integer
example: 80
tax_amount:
type: string
example: null
nullable: true
shipping_amount:
type: integer
example: 5
payment_transaction:
type: object
properties:
payment_id:
type: string
example: pi_1IglpAJBBrYOr00bW4tJ312
refunded:
type: boolean
example: false
payment_provider:
type: string
example: stripe
created_at:
type: string
example: '2022-04-16T11:19:25.000000Z'
last_updated:
type: string
example: '2022-04-16T11:19:25.000000Z'
line_items:
type: array
example:
-
line_item_id: 38
delivery_address: 'Street 1, XYZ Road, London, LLL 111'
quantity: 2
options: null
price: 0
delivery_dt: '2022-12-12'
status: placed
placed_at: '2022-04-16T11:19:25.000000Z'
items:
item_id: 15
sku: SKU123123123
external_link: ''
slug: Web-app-with-Vue-3-and-Tailwind-CSS
name: 'Web app with Vue 3 and Tailwind CSS'
price: 40
space:
name: 'Space 1'
-
line_item_id: 39
delivery_address: 'Street 1, XYZ Road, London, LLL 111'
quantity: 2
options: null
price: 0
delivery_dt: '2022-12-12'
status: placed
placed_at: '2022-04-16T11:19:25.000000Z'
items:
item_id: 16
external_link: ''
sku: null
slug: null
name: 'Designing with Canva '
price: 15.99
space:
name: 'Space 2'
items:
type: object
properties:
line_item_id:
type: integer
example: 38
delivery_address:
type: string
example: 'Street 1, XYZ Road, London, LLL 111'
quantity:
type: integer
example: 2
options:
type: string
example: null
nullable: true
price:
type: integer
example: 0
delivery_dt:
type: string
example: '2022-12-12'
status:
type: string
example: placed
placed_at:
type: string
example: '2022-04-16T11:19:25.000000Z'
items:
type: object
properties:
item_id:
type: integer
example: 15
sku:
type: string
example: SKU123123123
external_link:
type: string
example: ''
slug:
type: string
example: Web-app-with-Vue-3-and-Tailwind-CSS
name:
type: string
example: 'Web app with Vue 3 and Tailwind CSS'
price:
type: integer
example: 40
space:
type: object
properties:
name: { type: string, example: 'Space 1' }
tags:
- Orders
security: []
parameters:
-
in: path
name: uid
description: 'UID of the customer.'
example: de3523f0-9661-4d94-b0d7-04b4a31c06663cb128d0-296d-430b-adfa-badeee6a51935971fc62-2425-4e40-a425-c46008d4f16f3d494fca-46d9-4be6-8
required: true
schema:
type: string
'/api/v2/order/{invoice_number}':
get:
summary: 'Get Invoice/Order details'
operationId: getInvoiceOrderDetails
description: 'Provides the details of the invoice including the information of the line items ordered'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
invoice: bd402d30-9810-43b3-8c98-3f1c0208c098
total_amount: 80
payment_transaction:
payment_id: pi_1IglpAJBBrYOr00bW4tJ312
refunded: entire
payment_provider: stripe
created_at: '2022-02-18T01:30:26.000000Z'
last_updated: '2022-02-22T18:28:38.000000Z'
line_items:
-
line_item_id: 30
quantity: 2
options: null
price: 80
delivery_dt: '2022-12-12'
status: refunded
placed_at: '2022-02-18T01:30:26.000000Z'
items:
item_id: 15
external_link: ''
name: 'Web app with Vue 3 and Tailwind CSS'
slug: Web-app-with-Vue-3-and-Tailwind-CSS
space:
name: 'Space 1'
properties:
data:
type: array
example:
-
invoice: bd402d30-9810-43b3-8c98-3f1c0208c098
total_amount: 80
payment_transaction:
payment_id: pi_1IglpAJBBrYOr00bW4tJ312
refunded: entire
payment_provider: stripe
created_at: '2022-02-18T01:30:26.000000Z'
last_updated: '2022-02-22T18:28:38.000000Z'
line_items:
-
line_item_id: 30
quantity: 2
options: null
price: 80
delivery_dt: '2022-12-12'
status: refunded
placed_at: '2022-02-18T01:30:26.000000Z'
items:
item_id: 15
external_link: ''
name: 'Web app with Vue 3 and Tailwind CSS'
slug: Web-app-with-Vue-3-and-Tailwind-CSS
space:
name: 'Space 1'
items:
type: object
properties:
invoice:
type: string
example: bd402d30-9810-43b3-8c98-3f1c0208c098
total_amount:
type: integer
example: 80
payment_transaction:
type: object
properties:
payment_id:
type: string
example: pi_1IglpAJBBrYOr00bW4tJ312
refunded:
type: string
example: entire
payment_provider:
type: string
example: stripe
created_at:
type: string
example: '2022-02-18T01:30:26.000000Z'
last_updated:
type: string
example: '2022-02-22T18:28:38.000000Z'
line_items:
type: array
example:
-
line_item_id: 30
quantity: 2
options: null
price: 80
delivery_dt: '2022-12-12'
status: refunded
placed_at: '2022-02-18T01:30:26.000000Z'
items:
item_id: 15
external_link: ''
name: 'Web app with Vue 3 and Tailwind CSS'
slug: Web-app-with-Vue-3-and-Tailwind-CSS
space:
name: 'Space 1'
items:
type: object
properties:
line_item_id:
type: integer
example: 30
quantity:
type: integer
example: 2
options:
type: string
example: null
nullable: true
price:
type: integer
example: 80
delivery_dt:
type: string
example: '2022-12-12'
status:
type: string
example: refunded
placed_at:
type: string
example: '2022-02-18T01:30:26.000000Z'
items:
type: object
properties:
item_id:
type: integer
example: 15
external_link:
type: string
example: ''
name:
type: string
example: 'Web app with Vue 3 and Tailwind CSS'
slug:
type: string
example: Web-app-with-Vue-3-and-Tailwind-CSS
space:
type: object
properties:
name: { type: string, example: 'Space 1' }
tags:
- Orders
security: []
parameters:
-
in: path
name: invoice_number
description: 'Invoice number.'
example: bd402d30-9810-43b3-8c98-3f1c0208c098
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
properties:
data:
type: object
properties:
id:
type: integer
example: 43
name:
type: string
example: Events
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: perferendis
required:
- space_uid
- category
security: []
'/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
security: []
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: possimus
required:
- space_uid
- category
security: []
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:
text/plain:
schema:
type: string
example: "{\n\"data\": [\n {\n \"id\": 22,\n \"name\": \"Web Development Bootcamp\"\n},\n{\n \"id\": 23,\n \"name\": \"Programming\"\n},\n{\n \"id\": 36,\n \"name\": \"Mobile App Development\"\n}\n]"
tags:
- Category
security: []
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:
text/plain:
schema:
type: string
example: "{\n\"data\": [\n {\n \"id\": 22,\n \"name\": \"Web Development Bootcamp\"\n},\n{\n \"id\": 23,\n \"name\": \"Programming\"\n},\n{\n \"id\": 36,\n \"name\": \"Mobile App Development\"\n}\n]"
tags:
- Category
security: []
/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: null
name: 'Item ABC'
stock: 5
price: 10
scratched_price: 5
one_liner: null
description: null
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
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: null
nullable: true
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: null
nullable: true
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
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'
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
required:
- space_uid
- name
- categories
security: []
/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:
text/plain:
schema:
type: string
example: "{\n\n \"data\": \"Item deleted successfully\"\n\n}\n}"
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
security: []
/api/v2/update/item:
post:
summary: 'Update a item'
operationId: updateAItem
description: 'Update a item for a space'
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\n \"data\": \"Item updated successfully\"\n\n}\n}"
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'
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
security: []
/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
security: []
/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
security: []
/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
security: []
'/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: 16
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: 16
-
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: 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: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
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: ''
name:
type: string
example: 'Webdev courses in depth'
stock:
type: integer
example: 100
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
price:
type: integer
example: 40
external_link:
type: string
example: ''
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for begineer'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
type: array
example:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
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
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
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: 'Web Course Books'
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
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: aditya@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: aditya@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
tags:
- Item
security: []
parameters:
-
in: path
name: uid
description: ''
example: iure
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: 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:
text/plain:
schema:
type: string
example: "{\n\"data\": [\n{\n\"item_id\": 15,\n\"sku\": \"\",\n\"name\": \"Web app with Vue 3 and Tailwind CSS\",\n\"slug\": \"Web-app-with-Vue-3-and-Tailwind-CSS\",\n\"price\": 40,\n\"external_link\": \"\",\n\"scratched_price\": 0,\n\"one_liner\": \"A complete Vue.js course with front end web app development\",\n\"delivery_type\": \"online\",\n\"main_image\": \"https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg15png\",\n\"other_images\": [],\n\"attributes\": [],\n\"space\": {\n \"uid\": \"3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1\",\n \"name\": \"Aditya\"\n},\n\"avg_rating\": null,\n\"scheduled_for\": null,\n\"categories\" : [\n{\n \"id\": 22,\n \"name\": \"Web Development Bootcamp\"\n}\n],\n\"item_meta\": [\n {\n \"key\" : \"website\",\n \"value\": \"https://example.com\",\n \"type\": \"url\"\n }\n ],\n \"reactions\": [\n {\n \"reaction_id\": \"9b08ce6c-350c-4f00-9858-37a866bd626f\",\n \"reaction\": \"like\",\n \"user_identifier\": \"aditya@example.com\",\n \"created_at\": \"2024-01-07T09:54:12.000000Z\",\n \"updated_at\": \"2024-01-07T09:54:12.000000Z\"\n }\n ],\n\"created\": \"2022-11-06 20:52:39\",\n\"updated\": \"2023-07-08 15:09:16\"\n\"similarity\": 0.8\n},\n{\n\"item_id\": 29,\n\"sku\": \"\",\n\"name\": \"React native expo boot camp\",\n\"slug\": null,\n\"stock\": 0,\n\"price\": 75,\n\"scratched_price\": 0,\n\"one_liner\": \"Learn react native expo from beginner to pro\",\n\"delivery_type\": \"online\",\n\"main_image\": \"https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMain29png\",\n\"other_images\": [],\n\"attributes\": [],\n\"space\": {\n \"uid\": \"3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1\",\n \"name\": \"Aditya\"\n},\n\"avg_rating\": null,\n\"scheduled_for\": null,\n \"item_meta\": [\n ]\n\"categories\" : [\n {\n \"id\": 23,\n \"name\": \"Mobile App Development Bootcamp\"\n}\n],\n\"reactions\": [],\n\"created\": \"2022-11-06 20:52:39\",\n\"updated\": \"2023-07-08 15:09:16\",\n\"similarity\": 0.6\n}\n],\n\"links\": {\n \"first\": \"https://garchi.co.uk/api/v2/items?page=1\",\n \"last\": \"https://garchi.co.uk/api/v2/items?page=1\",\n \"prev\": null,\n \"next\": null\n},\n\"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://garchi.co.uk/api/v2/items?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n\"path\": \"https://garchi.co.uk/api/v2/items\",\n\"per_page\": 10,\n\"to\": 3,\n\"total\": 3\n}\n}"
tags:
- Item
security: []
/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: 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: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
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: ''
name:
type: string
example: 'Webdev courses in depth'
stock:
type: integer
example: 100
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
price:
type: integer
example: 40
external_link:
type: string
example: ''
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for begineer'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
type: array
example:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
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
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
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: 'Web Course Books'
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
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: aditya@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: aditya@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
tags:
- Item
security: []
'/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
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
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: ''
name:
type: string
example: 'Webdev courses in depth'
stock:
type: integer
example: 100
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
price:
type: integer
example: 40
external_link:
type: string
example: ''
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for begineer'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
type: array
example:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
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
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
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: 'Web Course Books'
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
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: aditya@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: aditya@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
tags:
- Item
security: []
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: 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: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
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: ''
name:
type: string
example: 'Webdev courses in depth'
stock:
type: integer
example: 100
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
price:
type: integer
example: 40
external_link:
type: string
example: ''
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for begineer'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
type: array
example:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
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
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
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: 'Web Course Books'
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
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: aditya@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: aditya@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
tags:
- Item
security: []
/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: 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: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
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: ''
name:
type: string
example: 'Webdev courses in depth'
stock:
type: integer
example: 100
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
price:
type: integer
example: 40
external_link:
type: string
example: ''
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for begineer'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
type: array
example:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
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
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
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: 'Web Course Books'
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
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: aditya@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: aditya@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
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'
security: []
/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
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
item_id: 26
sku: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
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: ''
name:
type: string
example: 'Webdev courses in depth'
stock:
type: integer
example: 100
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
price:
type: integer
example: 40
external_link:
type: string
example: ''
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for begineer'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
type: array
example:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
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
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
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: 'Web Course Books'
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
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: aditya@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: aditya@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
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
security: []
/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: 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: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
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: ''
name:
type: string
example: 'Webdev courses in depth'
stock:
type: integer
example: 100
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
price:
type: integer
example: 40
external_link:
type: string
example: ''
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for begineer'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
type: array
example:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
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
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
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: 'Web Course Books'
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
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: aditya@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: aditya@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
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
security: []
/api/v2/reviews/item:
post:
summary: 'Create new review for the item'
operationId: createNewReviewForTheItem
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": {\n \"review_id\": 15,\n \"review_body\": \"This is a best selling item\",\n \"rating\": 4,\n \"user\": {\n \"name\": \"Aditya\",\n \"email\": \"aditya@example.com\"\n },\n \"item_id\": 15,\n}\n}"
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: aditya@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: Aditya
parent_id:
type: integer
description: 'Id of the parent review.'
example: 4
required:
- item_id
- rating
security: []
/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
security: []
/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: 19
required:
- review_id
security: []
'/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:
text/plain:
schema:
type: string
example: "{\n\"data\": [\n {\n \"review_id\": 15,\n \"review_body\": \"This is a best selling item\",\n \"rating\": 4,\n \"guest\": null,\n \"user\": {\n \"fname\": \"Adi\",\n \"lname\": \"Kadam\"\n },\n \"item_id\": 15,\n \"reviewed_at\": \"2022-02-23T23:00:45.000000Z\",\n \"replies\": []\n \"reactions\": [],\n }\n],\n\"links\": {\n \"first\": \"https://garchi.co.uk/api/v2/reviews/seller/3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1?page=1\",\n \"last\": \"https://garchi.co.uk/api/v2/reviews/seller/3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1?page=1\",\n \"prev\": null,\n \"next\": null\n},\n\"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://garchi.co.uk/api/v2/reviews/seller/3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://garchi.co.uk/api/v2/reviews/seller/3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1\",\n \"per_page\": \"10\",\n \"to\": 3,\n \"total\": 3\n }\n}"
tags:
- Reviews
security: []
parameters:
-
in: path
name: item
description: 'ID of the item'
example: '15'
required: true
schema:
type: string
/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:
text/plain:
schema:
type: string
example: "{\n\"data\": [\n {\n \"uid\": \"3d5f84d6-8914-4061-b9be-cbdd8bcd806fb6138bbf-296e-44b4-9cf1-03b1\",\n \"name\": \"Aditya Kadam\",\n \"logo_url\": \"https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/SellersLogo/SellerLogo97T-1633021175.jpg\",\n \"number_of_items\": 3,\n },\n],\n\"links\": {\n \"first\": \"https://garchi.co.uk/api/v2/spaces?page=1\",\n \"last\": \"https://garchi.co.uk/api/v2/spaces?page=1\",\n \"prev\": null,\n \"next\": null\n},\n\"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://garchi.co.uk/api/v2/spaces?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://garchi.co.uk/api/v2/spaces\",\n \"per_page\": 10,\n \"to\": 3,\n \"total\": 3\n}\n}"
tags:
- Spaces
security: []
'/api/v2/space/{uid}':
get:
summary: 'Get Space details'
operationId: getSpaceDetails
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": {\n \"uid\": \"52690642-cc29-4c4d-a9dc-752d4036869e9b64f419-c900-49a8-9109-208a\",\n\"name\": null,\n \"logo_url\": \"https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/SellersLogo/SellerLogo191.svg\",\n \"number_of_items\": 24,\n \"average_rating\": null,\n}\n}"
tags:
- Spaces
security: []
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:
text/plain:
schema:
type: string
example: "\"data\": {\n\"uid\": \"3cbec0da-0c9f-4cd3-99e3-0b962477816dededd79c-d150-45ec-93b6-859c2f52b234\",\n \"name\": \"Aditya Kadam\",\n \"logo_url\": \"NA\",\n \"number_of_products\": null,\n}"
tags:
- Spaces
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: "Seller's full name"
example: '"Aditya Kadam"'
logo:
type: string
format: binary
description: "Seller's logo image file"
required:
- name
security: []
'/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
security: []
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: '"Aditya Kadam"'
logo:
type: string
format: binary
description: "Seller's logo image file"
security: []
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/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 a 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: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
created: '2022-11-06 20:52:39'
updated: '2023-07-08 15:09:16'
properties:
data:
type: array
example:
-
item_id: 26
sku: ''
name: 'Webdev courses in depth'
stock: 100
categories:
-
id: 22
name: 'Web Development Bootcamp'
price: 40
external_link: ''
scratched_price: null
one_liner: 'Best book for begineer'
description: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type: can_deliver
main_image: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
attributes:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
space:
uid: b5f0d08a-7600-4b9e-81e9-1ffaf5ddb8d2cf268eeb-000a-4bfd-bba6-09ab
name: 'Web Course Books'
avg_rating: null
scheduled_for: null
item_meta:
-
key: website
value: 'https://example.com'
type: url
reactions:
-
reaction_id: 9b08ce6c-350c-4f00-9858-37a866bd626f
reaction: like
user_identifier: aditya@example.com
created_at: '2024-01-07T09:54:12.000000Z'
updated_at: '2024-01-07T09:54:12.000000Z'
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: ''
name:
type: string
example: 'Webdev courses in depth'
stock:
type: integer
example: 100
categories:
type: array
example:
-
id: 22
name: 'Web Development Bootcamp'
items:
type: object
properties:
id:
type: integer
example: 22
name:
type: string
example: 'Web Development Bootcamp'
price:
type: integer
example: 40
external_link:
type: string
example: ''
scratched_price:
type: string
example: null
nullable: true
one_liner:
type: string
example: 'Best book for begineer'
description:
type: string
example: "This book is fantastic
\n\n- This
\n- Book
\n- is
\n- Fantastic
\n
"
delivery_type:
type: string
example: can_deliver
main_image:
type: string
example: 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImgMainpng'
other_images:
type: array
example:
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg1png'
- 'https://garchi.s3.eu-west-2.amazonaws.com/whitelabel_assets/Products/ProductImg2png'
items:
type: string
attributes:
type: array
example:
-
id: 16
name: 'Book Cover'
min: '1'
options:
-
id: 29
name: Paper
price: 0.5
-
id: 30
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
name: Paper
price: 0.5
-
id: 30
name: Binded
price: 1
items:
type: object
properties:
id:
type: integer
example: 29
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: 'Web Course Books'
avg_rating:
type: string
example: null
nullable: true
scheduled_for:
type: string
example: null
nullable: true
item_meta:
type: array
example:
-
key: website
value: 'https://example.com'
type: url
items:
type: object
properties:
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: aditya@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: aditya@example.com
created_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
updated_at:
type: string
example: '2024-01-07T09:54:12.000000Z'
created:
type: string
example: '2022-11-06 20:52:39'
updated:
type: string
example: '2023-07-08 15:09:16'
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"]'
security: []
'/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: 06f3310d-d550-4ab2-b824-d47f65ad3b29
path: 'https://garchi.s3.eu-west-2.amazonaws.com/headlessweb/62931923-b209-4e5c-9b91-57065cb443d279df607f-3026-45de-b684-5bee/myself2-1692799469.jpg'
size: 157.08KB
type: uploaded-image
properties:
id:
type: string
example: 06f3310d-d550-4ab2-b824-d47f65ad3b29
path:
type: string
example: 'https://garchi.s3.eu-west-2.amazonaws.com/headlessweb/62931923-b209-4e5c-9b91-57065cb443d279df607f-3026-45de-b684-5bee/myself2-1692799469.jpg'
size:
type: string
example: 157.08KB
type:
type: string
example: uploaded-image
tags:
- 'Headless Web'
security: []
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: 99bef509-c85a-4957-8340-8b4325421869
title: Home
slug: /
image: 'http://garchi.s3.eu-west-2.amazonaws.com/headlesswebpages/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/some_file.png'
description: 'a great space to be'
sections:
-
id: 99c21f3c-c434-4eb5-89ad-46e958a11081
name: Card
description: ''
props:
title: 'This is great'
description: 'Thanks for telling this'
image: 'http://garchi.s3.eu-west-2.amazonaws.com/headlessweb/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/Header Image-1690661182'
header: 'http://garchi.s3.eu-west-2.amazonaws.com/headlessweb/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/Header Image-1690661182'
data-garchi-section-id: 99c21f3c-c434-4eb5-89ad-46e958a11081
data-garchi-page-id: 99bef509-c85a-4957-8340-8b4325421869
children: []
order: 0
-
id: 99c210e4-330d-458f-9af3-b5eea6af228d
name: Navbar
description: /components/Navbar
props:
title: Home
link: 'https://google.com'
data-garchi-section-id: 99c210e4-330d-458f-9af3-b5eea6af228d
data-garchi-page-id: 99bef509-c85a-4957-8340-8b4325421869
children:
-
id: 99c3f4f6-7193-471e-a9c0-00ebca35811f
name: Logo
description: 'Main logo for the home page'
props:
src: 'http://garchi.s3.eu-west-2.amazonaws.com/headlessweb/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/Logo-1690661165'
data-garchi-section-id: 99c3f4f6-7193-471e-a9c0-00ebca35811f
data-garchi-page-id: 99bef509-c85a-4957-8340-8b4325421869
children:
-
id: 99c4274d-941e-42ad-845c-8c34258c729e
name: Navbar
description: /components/Navbar
props:
title: Logo
link: /
data-garchi-section-id: 99c4274d-941e-42ad-845c-8c34258c729e
data-garchi-page-id: 99bef509-c85a-4957-8340-8b4325421869
children: []
order: 0
order: 0
order: 1
-
id: 99c21ab9-e234-4a1a-a8af-324369332fc5
name: Logo
description: 'Main logo for the home page'
props:
src: 'http://garchi.s3.eu-west-2.amazonaws.com/headlessweb/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/Logo-1690661165'
data-garchi-section-id: 99c21ab9-e234-4a1a-a8af-324369332fc5
data-garchi-page-id: 99bef509-c85a-4957-8340-8b4325421869
children: []
order: 2
properties:
id:
type: string
example: 99bef509-c85a-4957-8340-8b4325421869
title:
type: string
example: Home
slug:
type: string
example: /
image:
type: string
example: 'http://garchi.s3.eu-west-2.amazonaws.com/headlesswebpages/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/some_file.png'
description:
type: string
example: 'a great space to be'
sections:
type: array
example:
-
id: 99c21f3c-c434-4eb5-89ad-46e958a11081
name: Card
description: ''
props:
title: 'This is great'
description: 'Thanks for telling this'
image: 'http://garchi.s3.eu-west-2.amazonaws.com/headlessweb/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/Header Image-1690661182'
header: 'http://garchi.s3.eu-west-2.amazonaws.com/headlessweb/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/Header Image-1690661182'
data-garchi-section-id: 99c21f3c-c434-4eb5-89ad-46e958a11081
data-garchi-page-id: 99bef509-c85a-4957-8340-8b4325421869
children: []
order: 0
-
id: 99c210e4-330d-458f-9af3-b5eea6af228d
name: Navbar
description: /components/Navbar
props:
title: Home
link: 'https://google.com'
data-garchi-section-id: 99c210e4-330d-458f-9af3-b5eea6af228d
data-garchi-page-id: 99bef509-c85a-4957-8340-8b4325421869
children:
-
id: 99c3f4f6-7193-471e-a9c0-00ebca35811f
name: Logo
description: 'Main logo for the home page'
props:
src: 'http://garchi.s3.eu-west-2.amazonaws.com/headlessweb/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/Logo-1690661165'
data-garchi-section-id: 99c3f4f6-7193-471e-a9c0-00ebca35811f
data-garchi-page-id: 99bef509-c85a-4957-8340-8b4325421869
children:
-
id: 99c4274d-941e-42ad-845c-8c34258c729e
name: Navbar
description: /components/Navbar
props:
title: Logo
link: /
data-garchi-section-id: 99c4274d-941e-42ad-845c-8c34258c729e
data-garchi-page-id: 99bef509-c85a-4957-8340-8b4325421869
children: []
order: 0
order: 0
order: 1
-
id: 99c21ab9-e234-4a1a-a8af-324369332fc5
name: Logo
description: 'Main logo for the home page'
props:
src: 'http://garchi.s3.eu-west-2.amazonaws.com/headlessweb/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/Logo-1690661165'
data-garchi-section-id: 99c21ab9-e234-4a1a-a8af-324369332fc5
data-garchi-page-id: 99bef509-c85a-4957-8340-8b4325421869
children: []
order: 2
items:
type: object
properties:
id:
type: string
example: 99c21f3c-c434-4eb5-89ad-46e958a11081
name:
type: string
example: Card
description:
type: string
example: ''
props:
type: object
properties:
title:
type: string
example: 'This is great'
description:
type: string
example: 'Thanks for telling this'
image:
type: string
example: 'http://garchi.s3.eu-west-2.amazonaws.com/headlessweb/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/Header Image-1690661182'
header:
type: string
example: 'http://garchi.s3.eu-west-2.amazonaws.com/headlessweb/c7ba17eb-4004-45ef-b5b3-1d557c5c85f4c34f4a69-3d08-444f-86e0-852b/Header Image-1690661182'
data-garchi-section-id:
type: string
example: 99c21f3c-c434-4eb5-89ad-46e958a11081
data-garchi-page-id:
type: string
example: 99bef509-c85a-4957-8340-8b4325421869
children:
type: array
example: []
order:
type: integer
example: 0
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
security: []
/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
security: []
/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: 0ba5a375-9626-4ac0-a402-a0bbfebf8fc1
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: 0ba5a375-9626-4ac0-a402-a0bbfebf8fc1
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: 0ba5a375-9626-4ac0-a402-a0bbfebf8fc1
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
security: []
'/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: 'Test page VerbalTide'
slug: /test-page-verbaltide
description: 'This is a test page for VerbalTide'
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: 'Test page VerbalTide'
slug:
type: string
example: /test-page-verbaltide
description:
type: string
example: 'This is a test page for VerbalTide'
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'
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'
path:
type: string
description: 'Path of the page.'
example: /
required:
- title
- description
- path
security: []
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: object
example:
data:
-
id: 01954433-a202-7220-891d-4d38c14fa6c5
title: Pricing
slug: /pricing
description: 'Generate amazing social media content from your video'
image: null
created_at: '2025-02-26T21:39:49.000000Z'
last_updated: '2025-07-25T19:08:57.000000Z'
-
id: 01982ee1-10fa-7280-a277-e7fbba25953e
title: 'Privacy policy'
slug: /privacy_policy
description: 'Privacy policy'
image: null
created_at: '2025-07-21T21:25:58.000000Z'
last_updated: '2025-08-14T19:52:57.000000Z'
-
id: 01982efe-6549-73e8-a44b-08140b4ab5fe
title: 'Cookie Policy'
slug: /cookie_policy
description: 'Cookie policy'
image: null
created_at: '2025-07-21T21:58:00.000000Z'
last_updated: '2025-07-25T19:09:21.000000Z'
-
id: 01982f00-dec0-72ff-a766-16d9257e7bd8
title: 'Acceptable use policy'
slug: /acceptable_use_policy
description: 'Acceptable Use Policy'
image: null
created_at: '2025-07-21T22:00:42.000000Z'
last_updated: '2025-08-14T19:53:35.000000Z'
-
id: 01982f04-30e6-70aa-aea0-f2e5f2b7562e
title: 'Terms and conditions'
slug: /website_terms_and_conditions
description: 'Terms and conditions'
image: null
created_at: '2025-07-21T22:04:20.000000Z'
last_updated: '2025-08-14T20:00:50.000000Z'
-
id: 01982f0c-8168-724e-a611-79e25bfc815a
title: 'Service terms and conditions'
slug: /service_terms_and_conditions
description: 'Service terms and conditions'
image: null
created_at: '2025-07-21T22:13:25.000000Z'
last_updated: '2025-10-22T14:15:24.000000Z'
-
id: 01988b64-1a2a-7011-95c5-1fc51c3f7c6f
title: 'Use cases'
slug: /use-cases
description: 'Your videos and podcasts deserve a second life. Instantly generate blog posts, social content, emails and more from a single clip.'
image: null
created_at: '2025-08-08T20:34:10.000000Z'
last_updated: '2025-08-09T22:35:25.000000Z'
-
id: 0198d1ac-38b7-71a5-adb7-9b8c21a7e86d
title: About
slug: /about
description: 'Your videos and podcasts deserve a second life. Instantly generate blog posts, social content, emails and more from a single clip.'
image: null
created_at: '2025-08-22T12:06:21.000000Z'
last_updated: '2025-08-22T13:05:25.000000Z'
properties:
data:
type: array
example:
-
id: 01954433-a202-7220-891d-4d38c14fa6c5
title: Pricing
slug: /pricing
description: 'Generate amazing social media content from your video'
image: null
created_at: '2025-02-26T21:39:49.000000Z'
last_updated: '2025-07-25T19:08:57.000000Z'
-
id: 01982ee1-10fa-7280-a277-e7fbba25953e
title: 'Privacy policy'
slug: /privacy_policy
description: 'Privacy policy'
image: null
created_at: '2025-07-21T21:25:58.000000Z'
last_updated: '2025-08-14T19:52:57.000000Z'
-
id: 01982efe-6549-73e8-a44b-08140b4ab5fe
title: 'Cookie Policy'
slug: /cookie_policy
description: 'Cookie policy'
image: null
created_at: '2025-07-21T21:58:00.000000Z'
last_updated: '2025-07-25T19:09:21.000000Z'
-
id: 01982f00-dec0-72ff-a766-16d9257e7bd8
title: 'Acceptable use policy'
slug: /acceptable_use_policy
description: 'Acceptable Use Policy'
image: null
created_at: '2025-07-21T22:00:42.000000Z'
last_updated: '2025-08-14T19:53:35.000000Z'
-
id: 01982f04-30e6-70aa-aea0-f2e5f2b7562e
title: 'Terms and conditions'
slug: /website_terms_and_conditions
description: 'Terms and conditions'
image: null
created_at: '2025-07-21T22:04:20.000000Z'
last_updated: '2025-08-14T20:00:50.000000Z'
-
id: 01982f0c-8168-724e-a611-79e25bfc815a
title: 'Service terms and conditions'
slug: /service_terms_and_conditions
description: 'Service terms and conditions'
image: null
created_at: '2025-07-21T22:13:25.000000Z'
last_updated: '2025-10-22T14:15:24.000000Z'
-
id: 01988b64-1a2a-7011-95c5-1fc51c3f7c6f
title: 'Use cases'
slug: /use-cases
description: 'Your videos and podcasts deserve a second life. Instantly generate blog posts, social content, emails and more from a single clip.'
image: null
created_at: '2025-08-08T20:34:10.000000Z'
last_updated: '2025-08-09T22:35:25.000000Z'
-
id: 0198d1ac-38b7-71a5-adb7-9b8c21a7e86d
title: About
slug: /about
description: 'Your videos and podcasts deserve a second life. Instantly generate blog posts, social content, emails and more from a single clip.'
image: null
created_at: '2025-08-22T12:06:21.000000Z'
last_updated: '2025-08-22T13:05:25.000000Z'
items:
type: object
properties:
id:
type: string
example: 01954433-a202-7220-891d-4d38c14fa6c5
title:
type: string
example: Pricing
slug:
type: string
example: /pricing
description:
type: string
example: 'Generate amazing social media content from your video'
image:
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'
tags:
- 'Headless Web'
security: []
parameters:
-
in: path
name: uid
description: ''
example: enim
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
prev_name:
type: string
example: ''
props:
type: array
example:
-
key: image
type: media
allowed_values: ''
-
key: image_position
type: select
allowed_values: 'left,right'
-
key: description
type: richtext
allowed_values: ''
-
key: is_video
type: select
allowed_values: 'yes,no'
-
key: title
type: text
allowed_values: ''
-
key: cta_text_2
type: text
allowed_values: ''
-
key: cta_link_2
type: text
allowed_values: ''
-
key: cta_text
type: text
allowed_values: ''
-
key: cta_link
type: text
allowed_values: ''
items:
type: object
properties:
key:
type: string
example: image
type:
type: string
example: media
allowed_values:
type: string
example: ''
id:
type: string
example: 0ba5a375-9626-4ac0-a402-a0bbfebf8fc1
example:
-
name: TwoColumnWithImage
description: layout/TwoColumnWithImage
prev_name: ''
props:
-
key: image
type: media
allowed_values: ''
-
key: image_position
type: select
allowed_values: 'left,right'
-
key: description
type: richtext
allowed_values: ''
-
key: is_video
type: select
allowed_values: 'yes,no'
-
key: title
type: text
allowed_values: ''
-
key: cta_text_2
type: text
allowed_values: ''
-
key: cta_link_2
type: text
allowed_values: ''
-
key: cta_text
type: text
allowed_values: ''
-
key: cta_link
type: text
allowed_values: ''
id: 0ba5a375-9626-4ac0-a402-a0bbfebf8fc1
-
name: FAQItem
description: ''
prev_name: ''
props:
-
key: answer
type: longtext
allowed_values: ''
-
key: question
type: text
allowed_values: ''
id: 0bcdfeaa-c3df-4dcc-af28-bc2739bc18a3
-
name: PricingCard
description: garchi/PricingCard
prev_name: ''
props:
-
key: features
type: longtext
allowed_values: ''
-
key: isFeatured
type: select
allowed_values: 'yes,no'
-
key: price
type: text
allowed_values: ''
-
key: description
type: text
allowed_values: ''
-
key: index
type: text
allowed_values: ''
-
key: stripe_price_id
type: text
allowed_values: ''
-
key: cta_text
type: text
allowed_values: ''
-
key: name
type: text
allowed_values: ''
id: 1076ef35-ceb7-42b8-b53f-5bf2eead7387
-
name: Markdown
description: Markdown
prev_name: ''
props:
-
key: content
type: richtext
allowed_values: ''
-
key: className
type: text
allowed_values: ''
id: 1d4762d2-4e48-4575-af35-b7aa4e96ed5e
-
name: Feature
description: garchi/Feature
prev_name: ''
props:
-
key: icon
type: icon_lucid
allowed_values: ''
-
key: title
type: text
allowed_values: ''
-
key: description
type: longtext
allowed_values: ''
id: 52189223-2277-4c7f-afb6-414e66937e29
-
name: Features
description: garchi/Features
prev_name: ''
props:
-
key: title
type: text
allowed_values: ''
-
key: subtitle
type: longtext
allowed_values: ''
id: 629f6165-c269-4360-a91c-f7e595dcd12a
-
name: YoutubeVideo
description: garchi/YoutubeVideo
prev_name: ''
props:
-
key: videoId
type: text
allowed_values: ''
-
key: style
type: text
allowed_values: ''
-
key: height
type: text
allowed_values: ''
-
key: width
type: text
allowed_values: ''
id: 66814479-f9bf-4cdd-8a06-00c94645f65e
-
name: Workflow
description: garchi/Workflow
prev_name: ''
props:
-
key: description
type: longtext
allowed_values: ''
-
key: title
type: text
allowed_values: ''
-
key: cta_text
type: text
allowed_values: ''
id: 672b7407-8685-4bd4-867c-8fe49f89811e
-
name: CTA
description: garchi/CTA
prev_name: ''
props:
-
key: ctaLink
type: text
allowed_values: ''
-
key: title
type: text
allowed_values: ''
-
key: description
type: longtext
allowed_values: ''
-
key: ctaText
type: text
allowed_values: ''
id: 6d68768d-897c-436b-ba59-58c524bd0dc5
-
name: Hero
description: garchi/Hero
prev_name: ''
props:
-
key: words
type: text
allowed_values: ''
-
key: description
type: longtext
allowed_values: ''
-
key: ctaLink
type: text
allowed_values: ''
-
key: title
type: text
allowed_values: ''
-
key: ctaText
type: text
allowed_values: ''
id: 6dc140ab-b8d6-47e9-abc0-095b9d9a29ec
-
name: FAQ
description: ui/faq
prev_name: ''
props: []
id: b5c2899b-711c-432b-8599-42838321207d
-
name: Pricing
description: garchi/Pricing
prev_name: ''
props:
-
key: title
type: text
allowed_values: ''
-
key: subheading
type: text
allowed_values: ''
id: e7f959e1-9b25-4313-aa46-70592a81c502
tags:
- 'Headless Web'
security: []
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/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:
type: object
example:
reaction_id: 1
reaction: like
user_identifier: aditya@example.com
created_at: '2023-10-01T12:00:00.000000Z'
updated_at: '2023-10-01T12:00:00.000000Z'
properties:
reaction_id:
type: integer
example: 1
reaction:
type: string
example: like
user_identifier:
type: string
example: aditya@example.com
created_at:
type: string
example: '2023-10-01T12:00:00.000000Z'
updated_at:
type: string
example: '2023-10-01T12:00:00.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: aditya@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
security: []