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

The Product Fields API from Erply — 2 operation(s) for product fields.

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

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

4 operations 2 paths 5 schemas 2 GET2 PATCH

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 Fields 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 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 2 PATCH. Each is listed below with its method, path, parameters, and response codes.

Product Fields 4
GET
/v1/product/fields/inherited
Read product fields that will be inherited from matrix products
→ 200400500
PATCH
/v1/product/fields/inherited
Set product fields that will be inherited from matrix products
1 param → 200400500
GET
/v1/product/fields/permissions
Read permissions for product fields
1 param → 200400500
PATCH
/v1/product/fields/permissions
Set permissions for product fields, permissions are user group based
2 params → 200400500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are products.ProductInheritedFieldsRequest (62 properties), products.ProductFieldsPermissions (62 properties), products.PermissionSet (2 properties), responses.MessageResponse (1 property). Each schema is shown below with its type and property counts.

responses.Response
object
1 property
products.PermissionSet
object
2 properties
products.ProductFieldsPermissions
object
62 properties
responses.MessageResponse
object
1 property
products.ProductInheritedFieldsRequest
object
62 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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