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

The Franchise Products API from Erply — 2 operation(s) for franchise products.

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

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

2 operations 2 paths 7 schemas 1 GET1 POST

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 Franchise 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 2

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

Franchise Products 2
POST
/v1/franchise-product/hq-to-store/{hqProductId}
Copies the hq product to the store
1 param → 201400500
GET
/v1/franchise-product/search
Search product with special franchise rules
6 params → 200400500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are products.ProductFranchiseSearchResponse (11 properties), products.ProductFranchiseUnit (2 properties), products.ProductFranchiseGroup (2 properties), products.ProductCopiedToStoreResponse (2 properties). Each schema is shown below with its type and property counts.

products.ProductFranchiseSearchResponse
object
11 properties
responses.MessageResponse
object
1 property
products.ProductFranchiseStockResponse
object
2 properties
Translatable
object
1 property
products.ProductCopiedToStoreResponse
object
2 properties
products.ProductFranchiseGroup
object
2 properties
products.ProductFranchiseUnit
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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