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

NB: Product picture management is done with CDN API: https://learn-api.erply.com/new-apis/cdn-api

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

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

This API exposes 17 operations across 11 paths, and defines 29 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.

17 operations 11 paths 29 schemas 1 DELETE6 GET3 PATCH5 POST2 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 Products 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 17

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

Products 17

NB: Product picture management is done with CDN API: https://learn-api.erply.com/new-apis/cdn-api

GET
/v1/product
Get Products, Product pictures: CDN API
6 params → 200400500
POST
/v1/product
Create a Product, Pictures: CDN API
4 params → 201400500
PUT
/v1/product/bulk
Update Products in bulk
1 param → 200
POST
/v1/product/bulk
Create Products in bulk
1 param → 200
PATCH
/v1/product/bulk
Update Product field by field in bulk
1 param → 200
POST
/v1/product/bulk/get
Get Products in bulk
1 param → 200
GET
/v1/product/codes
Get product codes
→ 200400500
PATCH
/v1/product/codes
Set/Update product codes
1 param → 201400500
GET
/v1/product/deleted/ids
Get Deleted Product IDs
3 params → 200400500
GET
/v1/product/full-text-lookup
Lookup products
3 params → 200400500
POST
/v1/product/merge
Merge a Product to another Product
1 param → 200400500
POST
/v1/product/restore
Restore products by backup ID
1 param → 200400500
GET
/v1/product/restore/info
Get information on restore
1 param → 200400404500
GET
/v1/product/{ids}
Get Products in batch
6 params → 200400404500
DELETE
/v1/product/{ids}
Delete Products
1 param → 200400500
PUT
/v1/product/{id}
Update Product
3 params → 200400500
PATCH
/v1/product/{id}
Update Product field by field
3 params → 200400500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are products.ProductResponse (99 properties), products.BulkCreateProductRequestItem (96 properties), products.BulkUpdateProductRequestItem (95 properties), products.BulkPatchUpdateProductRequestItem (95 properties). Each schema is shown below with its type and property counts.

parammodels.SortRequest
object
3 properties
products.BulkReadProductResponseItem
object
4 properties
products.AutoCodes
object
2 properties
products.BulkPatchUpdateProductRequestItem
object
95 properties
Translatable
object
1 property
responses.Response
object
1 property
parammodels.FilterJSON
object
5 properties
ProductDescription
object
2 properties
models.BackupRequest
object
1 property
products.PatchUpdateProductRequest
object
94 properties
parammodels.BulkReadRequestNoTotalCount
object
1 property
products.BulkUpdateProductRequestItem
object
95 properties
models.BackupSampleProduct
object
3 properties
responses.MessageResponse
object
1 property
responses.BulkResult
object
3 properties
products.ProductMergeRequest
object
4 properties
responses.BulkResponseWithResults
object
1 property
parammodels.ReadRequest
object
3 properties
products.BulkCreateProductRequestItem
object
96 properties
products.BulkReadProductResponse
object
1 property
Description
object
1 property
products.ProductRequest
object
94 properties
products.BulkPatchUpdateProductRequest
object
1 property
parammodels.PaginationParameters
object
2 properties
products.BulkUpdateProductRequest
object
1 property
products.BulkCreateProductRequest
object
1 property
models.BackupChanges
object
2 properties
products.ProductResponse
object
99 properties
products.CreateUpdateAutoCodes
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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