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 Family API

The Product Family API from Erply — 4 operation(s) for product family.

Erply Product Family 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 Family. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 15 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.

5 operations 4 paths 15 schemas 1 GET3 POST1 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 Family 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 5

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

Product Family 5
GET
/v1/product/family
Get Families
5 params → 200400500
POST
/v1/product/family
Create Family
1 param → 201400500
POST
/v1/product/family/bulk
Create families in bulk
1 param → 200
POST
/v1/product/family/bulk/get
Get families in bulk
1 param → 200
PUT
/v1/product/family/{id}
Update Family
2 params → 200400500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are familymodels.Response (7 properties), parammodels.FilterJSON (5 properties), familymodels.ReadRequest (4 properties), parammodels.SortRequest (3 properties). Each schema is shown below with its type and property counts.

responses.Response
object
1 property
familymodels.BulkReadResponseItem
object
3 properties
parammodels.FilterJSON
object
5 properties
familymodels.Response
object
7 properties
familymodels.BulkReadRequest
object
1 property
responses.MessageResponse
object
1 property
familymodels.BulkReadResponse
object
1 property
parammodels.SortRequest
object
3 properties
parammodels.PaginationParameters
object
2 properties
Translatable
object
1 property
requests.Archivable
object
2 properties
familymodels.BulkCreateRequest
object
1 property
responses.BulkResult
object
3 properties
familymodels.ReadRequest
object
4 properties
responses.BulkResponseWithResults
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-product-family-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