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

The Product Parameter API from Erply — 5 operation(s) for product parameter.

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

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

6 operations 5 paths 13 schemas 1 DELETE3 GET1 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 Parameter 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 6

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

Product Parameter 6
GET
/v1/product/parameter
Get Product Parameters
6 params → 200400500
POST
/v1/product/parameter
A parameter always belongs to exactly one data set (not multiple data sets at the same time, and a parameter cannot exist without a set). A parameter has a name and a type.
1 param → 201400500
DELETE
/v1/product/parameter/{ids}
Delete Product Parameters
1 param → 200400500
PUT
/v1/product/parameter/{id}
Update Product Parameter
2 params → 200400500
GET
/v1/product/parameter/{id}/products
Get products that have values for this parameter
3 params → 200400500
GET
/v1/product/{id}/parameters
Get All Parameters for the Product by ID
3 params → 200400500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are products.ProductResponse (99 properties), parametermodels.ParameterWithOptionsResponse (12 properties), parametermodels.ParameterResponse (11 properties), parametermodels.OptionResponse (7 properties). Each schema is shown below with its type and property counts.

responses.Response
object
1 property
Description
object
1 property
products.ProductResponseWithParametersRecord
object
2 properties
ProductDescription
object
2 properties
parametermodels.ParameterWithOptionsResponse
object
12 properties
parametermodels.ParameterResponse
object
11 properties
requests.ParameterRequest
object
3 properties
parametermodels.OptionResponse
object
7 properties
products.ProductResponseWithParameters
object
1 property
responses.MessageResponse
object
1 property
requests.Request
object
1 property
Translatable
object
1 property
products.ProductResponse
object
99 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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