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

The Supplier API from Erply — 6 operation(s) for supplier.

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

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

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

7 operations 6 paths 16 schemas 1 DELETE2 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 Supplier 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 7

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

Supplier 7
GET
/v1/supplier
Get Suppliers
5 params → 200400500
POST
/v1/supplier
Create Supplier
1 param → 201400500
POST
/v1/supplier/bulk
Create suppliers in bulk
1 param → 200
POST
/v1/supplier/bulk/get
Get suppliers in bulk
1 param → 200
GET
/v1/supplier/type
Get Supplier Types
4 params → 200400500
DELETE
/v1/supplier/{ids}
Delete suppliers
1 param → 200400500
PUT
/v1/supplier/{id}
Update Supplier
2 params → 200400500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are models.SupplierResponse (31 properties), models.SupplierRequest (26 properties), models.SupplierTypeResponse (8 properties), parammodels.FilterJSON (5 properties). Each schema is shown below with its type and property counts.

responses.Response
object
1 property
parammodels.FilterJSON
object
5 properties
models.SupplierTypeResponse
object
8 properties
models.SupplierResponse
object
31 properties
parammodels.SortRequest
object
3 properties
responses.MessageResponse
object
1 property
parammodels.PaginationParameters
object
2 properties
models.SupplierRequest
object
26 properties
Translatable
object
1 property
parammodels.ReadRequestWithTotalCount
object
4 properties
models.BulkCreateSupplierRequest
object
1 property
models.BulkReadSuppliersResponse
object
1 property
models.BulkReadSuppliersResponseItem
object
4 properties
responses.BulkResult
object
3 properties
parammodels.BulkReadRequest
object
1 property
responses.BulkResponseWithResults
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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