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

The Brand API from Erply — 5 operation(s) for brand.

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

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

This API exposes 6 operations across 5 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.

6 operations 5 paths 15 schemas 1 DELETE1 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 Brand 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, 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Brand 6
GET
/v1/brand
Get brands
5 params → 200400500
POST
/v1/brand
Create brand
1 param → 201400500
POST
/v1/brand/bulk
Create brands in bulk
1 param → 200
POST
/v1/brand/bulk/get
Get brands in bulk
1 param → 200
DELETE
/v1/brand/{ids}
Delete brands
1 param → 200400500
PUT
/v1/brand/{id}
Update brand
2 params → 200400500

Schemas 15

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

parammodels.ReadRequest
object
3 properties
brandmodels.BulkResponse
object
1 property
parammodels.FilterJSON
object
5 properties
responses.Response
object
1 property
brandmodels.BulkCreateRequest
object
1 property
parammodels.SortRequest
object
3 properties
responses.MessageResponse
object
1 property
parammodels.PaginationParameters
object
2 properties
brandmodels.BulkResponseItem
object
3 properties
brandmodels.Request
object
2 properties
Translatable
object
1 property
brandmodels.Response
object
7 properties
responses.BulkResult
object
3 properties
parammodels.BulkReadRequestNoTotalCount
object
1 property
responses.BulkResponseWithResults
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-brand-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 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