Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Erply Product Category API

The Product Category API from Erply — 8 operation(s) for product category.

Erply Product Category API is one of 64 APIs that Erply publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Product Category. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 8 paths, and defines 22 schemas. It is described by OpenAPI 2.0, at version 2.36.5.

Requests are made against the base URL https://api-pim-eu.erply.com.

9 operations 8 paths 22 schemas 1 DELETE3 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.36.5
Base URL
https://api-pim-eu.erply.com
Authentication
API Key, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 5

Erply Product Category API declares 5 security schemes for authenticating requests. An API key is passed in the header as accessToken (AccessToken). An API key is passed in the header as clientCode (ErplyClientCode). An API key is passed in the header as jwt (ErplyJWT). An API key is passed in the header as sessionKey (ErplySession). An API key is passed in the header as requestKey (RequestKey).

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Product Category 9
GET
/v1/product/category
Get Categories
5 params → 200400500
POST
/v1/product/category
Create Product Category
1 param → 201400500
POST
/v1/product/category/bulk
Create categories in bulk
1 param → 200
POST
/v1/product/category/bulk/get
Get categories in bulk
1 param → 200
GET
/v1/product/category/indented
Get Indented List of Categories
1 param → 200400500
GET
/v1/product/category/tree
Get Tree of product categories
10 params → 200400500
DELETE
/v1/product/category/{ids}
Delete Product Categories
1 param → 200400500
PUT
/v1/product/category/{id}
Update Product Category
2 params → 200400500
PUT
/v1/product/category/{id}/move
Move Product Category
2 params → 200400500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are products.ProductResponse (99 properties), categorymodels.Response (8 properties), parammodels.FilterJSON (5 properties), categorymodels.BulkReadResponseItem (4 properties). Each schema is shown below with its type and property counts.

parammodels.SortRequest
object
3 properties
Translatable
object
1 property
indentation.Result
object
2 properties
categorymodels.Request
object
2 properties
responses.Response
object
1 property
indentation.CategoryTreeResultSampleNoChildren
object
2 properties
parammodels.FilterJSON
object
5 properties
ProductDescription
object
2 properties
categorymodels.BulkCreateRequest
object
1 property
categorymodels.BulkReadResponseItem
object
4 properties
parammodels.ReadRequestWithTotalCount
object
4 properties
models.MoveRequest
object
2 properties
categorymodels.Response
object
8 properties
responses.MessageResponse
object
1 property
indentation.CategoryTreeResultSample
object
3 properties
responses.BulkResult
object
3 properties
responses.BulkResponseWithResults
object
1 property
parammodels.BulkReadRequest
object
1 property
Description
object
1 property
categorymodels.BulkReadResponse
object
1 property
parammodels.PaginationParameters
object
2 properties
products.ProductResponse
object
99 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-product-category-api-openapi.yml Raw ↑

Other APIs Erply publishes across the network.

Erply Assortment API
Erply Assortment To Product Linking API
Erply Attributes API
Erply auth API
Erply Brand API
Erply clsf API
Erply clsf-device-properties API
Erply clsf-events API
Erply clsf-labels API
Erply Country API
Erply device API
Erply event API