Read and search categories

Use the following endpoint to search and read the categories we have in the system.

Description	Read and search categories
HTTP Method	GET
URL	https://api.midway.la/api/consumer/categories
Headers	X-Tenant: Authorization: Bearer
Rate limit	60 requests per minute
JSON request (example)	none
JSON response (example)
Paging and filtering (example)	The paging and filters can be combined. Filtering: # Search by id https://api.midway.la/api/consumer/categories?category_id=category_123 # Search by source https://api.midway.la/api/consumer/categories?source=vtex Paging: https://api.midway.la/api/consumer/categories?source=vtex&page=2&per_page=250

Create and update categories

Use the following endpoint to create and update the categories of your company in our system, we use the parameter “category_id” to create or update the categories. You can send many categories in one request.

Descripción	Create and update categories.
HTTP Method	POST
URL	https://api.midway.la/api/consumer/categories/bulk
Headers	X-Tenant: Authorization: Bearer
Rate limit	60 requests per minute
Reference	See the CategoriesDTO table below.
JSON request (example)
JSON response (example)	status code 204
Paging and filtering (example)	none

Delete category

Use the following endpoint to delete the categories of your company in our system, we use the parameter “category_id” to delete. You can send many categories in one request to delete.

Descripción	Delete categories.
HTTP Method	DELETE
URL	https://api.midway.la/api/consumer/categories/delete
Headers	X-Tenant: Authorization: Bearer
Rate limit	30 requests per minute
JSON request (example)
JSON response (example)	status code 204
Paging and filtering (example)	none

The parameters that have “*” are required.

CategoriesDTO

Parameter	Type	Description
source*	string	The source is from which application the information comes from (vtex, prestashop, system,crm, etc).
categories*	List <CategoryDTO>	The categories field is the list of categories to be uploaded in bulk.

CategoryDTO

Parameter	Type	Description
category_id*	string	The category_id field is the id of the category.
name*	string	The name field is the name of the category.
url*	string	The url field is the url of the category.