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

The Product Group API from Erply — 15 operation(s) for product group.

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

This API exposes 17 operations across 15 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 15 paths 29 schemas 3 DELETE5 GET2 PATCH4 POST3 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 Group 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 15 paths, the API surfaces 17 operations — 3 DELETE, 5 GET, 2 PATCH, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Product Group 17
GET
/v1/product/group
Get Groups
5 params → 200400500
POST
/v1/product/group
Create Product Group
1 param → 201400500
POST
/v1/product/group/bulk
Create groups in bulk
1 param → 200
POST
/v1/product/group/bulk/get
Get groups in bulk
1 param → 200
GET
/v1/product/group/external-ids
Read external group IDs of Product Groups
5 params → 200400500
DELETE
/v1/product/group/external-ids/{groupIds}
Delete external group IDs of Product Groups
2 params → 201400500
POST
/v1/product/group/external-ids/{groupId}
Attach external group ID to a Product Group
2 params → 201400500
PATCH
/v1/product/group/external-ids/{groupId}
Update external group ID of a Product Group
2 params → 201400500
GET
/v1/product/group/indented
Get Indented List of Groups
1 param → 200400500
GET
/v1/product/group/tree
Get Tree of product groups
10 params → 200400500
DELETE
/v1/product/group/{groupId}/location-tax/{warehouseId}
Delete Location Specific Tax From Product Group
2 params → 200400500
DELETE
/v1/product/group/{ids}
Delete Product Groups
1 param → 200400500
PUT
/v1/product/group/{id}
Update Product Group
2 params → 200400500
PATCH
/v1/product/group/{id}/location-tax
Add Location Specific Tax
2 params → 200400500
PUT
/v1/product/group/{id}/move
Move Product Group
2 params → 200400500
GET
/v1/product/{ids}/additional-groups
Get Product's Additional Groups
3 params → 200400500
PUT
/v1/product/{id}/additional-groups
Attach Additional Groups to Product
2 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), groupmodels.GroupResponse (16 properties), groupmodels.GroupRequest (9 properties), groupmodels.ExternalIDResponse (7 properties). Each schema is shown below with its type and property counts.

groupmodels.AdditionalGroupsResponse
object
1 property
parammodels.SortRequest
object
3 properties
Translatable
object
1 property
indentation.Result
object
2 properties
groupmodels.LocationTaxRate
object
2 properties
groupmodels.GroupRequest
object
9 properties
indentation.GroupTreeResultSample
object
3 properties
parammodels.FilterJSON
object
5 properties
responses.Response
object
1 property
ProductDescription
object
2 properties
parammodels.ReadRequestWithTotalCount
object
4 properties
indentation.GroupTreeResultSampleNoChildren
object
2 properties
groupmodels.GroupResponse
object
16 properties
groupmodels.AdditionalGroupRequest
object
1 property
groupmodels.BulkReadGroupsResponse
object
1 property
models.MoveRequest
object
2 properties
groupmodels.ExternalIDRequest
object
2 properties
responses.MessageResponse
object
1 property
groupmodels.AdditionalGroupJSON
object
7 properties
responses.BulkResult
object
3 properties
groupmodels.ExternalIDResponse
object
7 properties
responses.BulkResponseWithResults
object
1 property
parammodels.BulkReadRequest
object
1 property
Description
object
1 property
parammodels.PaginationParameters
object
2 properties
groupmodels.LocationSpecificTaxRequest
object
2 properties
groupmodels.BulkCreateGroupsRequest
object
1 property
groupmodels.BulkReadGroupsResponseItem
object
4 properties
products.ProductResponse
object
99 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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