Catalog

Content negotiation

Catalog Endpoints

admin

Method	URI	Name	Summary
POST	/v1/category	create category	Create Category
POST	/v1/product	create product	Create Product
DELETE	/v1/category/{id}	delete category	Delete Category
DELETE	/v1/product/{id}	delete product	Delete Product
GET	/v1/categories	get all categories	Get All Categories
GET	/v1/products/{currentPage}/{pageSize}	get all products	Get All Products
GET	/v1/category/{id}	get category by Id	Get Category By Id
GET	/v1/category/slug/{slug}	get category by slug	Get Category By Slug
GET	/v1/product/{id}	get product by Id	Get Product By Id
GET	/v1/product/sku/{sku}	get product by sku	Get Product By Sku
GET	/v1/product/slug/{slug}	get product by slug	Get Product By Slug
GET	/v1/products/{categoryId}/{currentPage}/{pageSize}	get products by category Id	Get Products By Category Id
PUT	/v1/category/{id}	update category	Update Category
PUT	/v1/product/{id}	update product	Update Product

Paths

Create Category (createCategory)

POST /v1/category

creates a category

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
body	`body`	CreateCategoryRequest	`models.CreateCategoryRequest`		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

CreateCategoryResponse

Create Product (createProduct)

POST /v1/product

creates a product

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
body	`body`	CreateProductRequest	`models.CreateProductRequest`		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

CreateProductResponse

Delete Category (deleteCategory)

DELETE /v1/category/{id}

deletes a category

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
id	`path`	string	`string`		✓		category id
body	`body`	DeleteCategoryRequest	`models.DeleteCategoryRequest`		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

DeleteCategoryResponse

Delete Product (deleteProduct)

DELETE /v1/product/{id}

delete a product

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
id	`path`	string	`string`		✓		product id
body	`body`	DeleteProductRequest	`models.DeleteProductRequest`		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

DeleteProductResponse

Get All Categories (getAllCategories)

GET /v1/categories

returns all categories belonging to a store

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

GetAllCategoriesResponse

Get All Products (getAllProducts)

GET /v1/products/{currentPage}/{pageSize}

returns all products belonging to a store

Parameters

Name	Source	Type	Go type	Required	Description
currentPage	`path`	string	`string`	✓	current page number
pageSize	`path`	string	`string`	✓	number of records per page
sortOn	`query`	string	`string`	✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

GetAllProductsResponse

Get Category By Id (getCategoryById)

GET /v1/category/{id}

returns all categories by id belonging to a store

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
id	`path`	string	`string`		✓		category id
id	`query`	int64 (formatted integer)	`int64`		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

GetCategoryByIDResponse

Get Category By Slug (getCategoryBySlug)

GET /v1/category/slug/{slug}

returns all categories by slug belonging to a store

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
slug	`path`	string	`string`		✓		category slug

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

GetCategoryBySlugResponse

Get Product By Id (getProductById)

GET /v1/product/{id}

returns matching product by id

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
id	`path`	string	`string`		✓		product id

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

GetProductResponse

Get Product By Sku (getProductBySku)

GET /v1/product/sku/{sku}

returns all products by sku belonging to a store

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
sku	`path`	string	`string`		✓		product sku

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

GetProductResponse

Get Product By Slug (getProductBySlug)

GET /v1/product/slug/{slug}

returns matching product by slug

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
slug	`path`	string	`string`		✓		product slug

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

GetProductResponse

Get Products By Category Id (getProductsByCategoryId)

GET /v1/products/{categoryId}/{currentPage}/{pageSize}

returns all products by category id belonging to a store

Parameters

Name	Source	Type	Go type	Required	Description
categoryId	`path`	string	`string`	✓	category id
currentPage	`path`	string	`string`	✓	current page number
pageSize	`path`	string	`string`	✓	number of records per page
sortOn	`query`	string	`string`

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

GetProductsByCategoryIDResponse

Update Category (updateCategory)

PUT /v1/category/{id}

updates a category

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
id	`path`	string	`string`		✓		category id
body	`body`	UpdateCategoryRequest	`models.UpdateCategoryRequest`		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

UpdateCategoryResponse

Update Product (updateProduct)

PUT /v1/product/{id}

updates a product

Parameters

Name	Source	Type	Go type	Separator	Required	Default	Description
id	`path`	string	`string`		✓		product id
body	`body`	UpdateProductRequest	`models.UpdateProductRequest`		✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	A successful response.		schema

Responses

200 - A successful response.

Status: OK

Schema

UpdateProductResponse

Models

Name	Type	Go type	Required	Description
description	string	`string`	✓	description of category
id	int64 (formatted integer)	`int64`	✓	category id
metaDescription	string	`string`	✓	metatag description for SEO
metaKeywords	string	`string`	✓	metatag keywords for SEO
metaTitle	string	`string`	✓	metatag title for SEO
name	string	`string`	✓	name of category
parentId	int64 (formatted integer)	`int64`	✓	parent category id. references Category.Id
slug	string	`string`	✓	slug name of the category
sortOrder	int32 (formatted integer)	`int32`	✓	sort order of menu items on the same level and same parent id

CreateCategoryRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
category	Category	`Category`	✓

CreateCategoryResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
category	Category	`Category`	✓
status	ResponseStatus	`ResponseStatus`	✓		a ResponseStatus object

CreateProductRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
product:omitempty	Product	`Product`	✓

CreateProductResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
product:omitempty	Product	`Product`	✓
status	ResponseStatus	`ResponseStatus`	✓		a ResponseStatus object

DeleteCategoryRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
id	int64 (formatted integer)	`int64`	✓

DeleteCategoryResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
status	ResponseStatus	`ResponseStatus`	✓		a ResponseStatus object

DeleteProductRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
path:omitempty	int64 (formatted integer)	`int64`	✓

DeleteProductResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
status	ResponseStatus	`ResponseStatus`	✓		a ResponseStatus object

GetAllCategoriesResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
categories	[]Category	`[]*Category`	✓		a collection of Category
status	ResponseStatus	`ResponseStatus`	✓		a ResponseStatus object

GetAllProductsRequest

Properties

Name	Type	Go type	Required
currentPage	int64 (formatted integer)	`int64`	✓
pageSize	int64 (formatted integer)	`int64`	✓
sortOn	string	`string`	✓

GetAllProductsResponse

Properties

Name	Type	Go type	Required	Description
products	[]Product	`[]*Product`	✓
status	ResponseStatus	`ResponseStatus`	✓	a ResponseStatus object
totalPages	int64 (formatted integer)	`int64`	✓
totalRecords	int64 (formatted integer)	`int64`	✓

GetCategoryByIdRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
id	int64 (formatted integer)	`int64`	✓

GetCategoryByIdResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
category	Category	`Category`	✓
status	ResponseStatus	`ResponseStatus`	✓		a ResponseStatus object

GetCategoryBySlugRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
slug	string	`string`	✓		slug name of the category

GetCategoryBySlugResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
category	Category	`Category`	✓
status	ResponseStatus	`ResponseStatus`	✓		a ResponseStatus object

GetProductByIdRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
id	int64 (formatted integer)	`int64`	✓

GetProductBySkuRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
sku	string	`string`	✓

GetProductBySlugRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
slug	string	`string`	✓		slug name of the category

GetProductResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
product	Product	`Product`	✓		slug name of the category
status	ResponseStatus	`ResponseStatus`	✓		a ResponseStatus object

GetProductsByCategoryIdRequest

Properties

Name	Type	Go type	Required
categoryId	int64 (formatted integer)	`int64`	✓
currentPage	int64 (formatted integer)	`int64`	✓
pageSize	int64 (formatted integer)	`int64`	✓
sortOn	string	`string`

GetProductsByCategoryIdResponse

Properties

Name	Type	Go type	Required	Description
products	[]Product	`[]*Product`	✓
status	ResponseStatus	`ResponseStatus`	✓	a ResponseStatus object
totalPages	int64 (formatted integer)	`int64`	✓
totalRecords	int64 (formatted integer)	`int64`	✓

JwtToken

Properties

Name	Type	Go type	Required
accessExpire	int64 (formatted integer)	`int64`	✓
accessToken	string	`string`	✓
refreshAfter	int64 (formatted integer)	`int64`	✓

Price

Properties

Name	Type	Go type	Required	Description
amount	double (formatted number)	`float64`	✓	price amount
compareAtAmount	double (formatted number)	`float64`	✓	price compare amount
currency	string	`string`	✓	price currency. example: USD, CAN, etc.
displayAmount	string	`string`	✓	price display amount
displayCompareAtAmount	string	`string`	✓	price display compare amount
id	int64 (formatted integer)	`int64`	✓	price id

Product

Properties

Name	Type	Go type	Required	Description
description	string	`string`	✓	category description
id	int64 (formatted integer)	`int64`	✓	product id
metaDescription	string	`string`	✓	metatag description for SEO
metaKeywords	string	`string`	✓	metatag keywords for SEO
metaTitle	string	`string`	✓	metatag title for SEO
name	string	`string`	✓	product name
shortDescription	string	`string`	✓	product short description. used in category pages
slug	string	`string`	✓	product slug
variants	[]Variant	`[]*Variant`	✓	collection of Variant objects

ResponseStatus

Properties

Name	Type	Go type	Required	Default	Description	Example
statusCode	int64 (formatted integer)	`int64`	✓		RFC http status code, ie. 204, etc - https:go.dev/src/net/http/status.go
statusMessage	string	`string`	✓		status message

UpdateCategoryRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
category	Category	`Category`	✓
id	int64 (formatted integer)	`int64`	✓

UpdateCategoryResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
category	Category	`Category`	✓
status	ResponseStatus	`ResponseStatus`	✓		a ResponseStatus object

UpdateProductRequest

Properties

Name	Type	Go type	Required	Default	Description	Example
path:omitempty	int64 (formatted integer)	`int64`	✓
product:omitempty	Product	`Product`	✓

UpdateProductResponse

Properties

Name	Type	Go type	Required	Default	Description	Example
product:omitempty	Product	`Product`	✓
status	ResponseStatus	`ResponseStatus`	✓		a ResponseStatus object

Variant

Properties

Name	Type	Go type	Required	Description
depth	double (formatted number)	`float64`	✓	variant depth. used in calculating shipping
height	double (formatted number)	`float64`	✓	variant height. used in calculating shipping
id	int64 (formatted integer)	`int64`	✓	variant id
isDefault	boolean (formatted boolean)	`bool`	✓	is default variant. each product must have exactly 1 default variant
price	Price	`Price`	✓	variant Price object
sku	string	`string`	✓	variant sku. usually the product sku with appended identification tags
weight	double (formatted number)	`float64`	✓	variant weight. used in calculating shipping
width	double (formatted number)	`float64`	✓	variant width. used in calculating shipping

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified January 19, 2022: content update (ec6fd04)