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

Attributes are attached to entities. The possible entities are: product, recipe, warehouse location, assortment, brand, matrix dimension, matrix dimension value, category, country, family, group, package, parameter, parameter option, parameter set, parameter validation rule, parameter value, unit, supplier

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

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

This API exposes 3 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.

3 operations 2 paths 5 schemas 1 DELETE1 GET1 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 Attributes 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 3

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

Attributes 3

Attributes are attached to entities. The possible entities are: product, recipe, warehouse location, assortment, brand, matrix dimension, matrix dimension value, category, country…

GET
/v1/attribute
Read Attributes
6 params → 200400500
PUT
/v1/attribute
Attach / Update an Attribute
1 param → 201400500
DELETE
/v1/attribute/{ids}
Delete Attributes by ID
1 param → 200400500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are models.AttributeResponse (6 properties), models.AttributeRequest (6 properties), responses.BulkResponse (1 property), responses.MessageResponse (1 property). Each schema is shown below with its type and property counts.

responses.Response
object
1 property
responses.MessageResponse
object
1 property
models.AttributeRequest
object
6 properties
models.AttributeResponse
object
6 properties
responses.BulkResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-attributes-api-openapi.yml Raw ↑

Other APIs Erply publishes across the network.

Erply Assortment API
Erply Assortment To Product Linking 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
Erply Export API