Product API
/
General configuration
/
Update the general configuration of a retailer/e-commerce platform (merchant).

Jay Product Data API (2025-07-09)

The Jay Product Data API of the Media Jay application provides the capability to add full or update volatile (stock count, prices, etc.) product data.

Authentication

To access the endpoints you require a X-API-Key in the header. Partners, please contact Transfermedia support@transfermedia.de to retrieve one.

Versioning

To use a specific implementation version of this API place it to the request header X-API-Version. If the header is missed the latest implementation version 2025-07-09 is used. The response header X-API-Version returns the implementation version the request was processed with.

Further documentation

For further details please visit the documentation or contact Transfermedia support@transfermedia.de.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Development Server

https://docs.jay-metadata.com/_mock/apis/product/latest/openapi/

General configuration

Operations

Get the general configuration of a retailer/e-commerce platform (merchant).

Request

Get the general configuration of a retailer/e-commerce platform (merchant).

curl -i -X GET \
  https://docs.jay-metadata.com/_mock/apis/product/latest/openapi/shops/config

Responses

Successfully exported the general configuration of a retailer/e-commerce platform (merchant).

Bodyapplication/json
dataany(The response data)

The response data.

nextTokenstring(Next token)

The token, which can be used to retrieve the next page of data.

errorobject(The error response)

Represents a data response with a possible error.

Response
application/json
{
  "data": null,
  "nextToken": "string",
  "error": {
    "code": 1001,
    "message": "string",
    "details": null
  }
}

Update the general configuration of a retailer/e-commerce platform (merchant).

Request

Update the general configuration of a retailer/e-commerce platform (merchant). Each field can be updated individually.

Bodyapplication/jsonrequired
shippingModelobject(The shipping model)

Represents the shipping model for a retailer/e-commerce shop (merchant).

vatnumber(The VAT (value added tax) in percent)>= 0

The VAT (value added tax) in percent (e.g. 19.0%).

Example: 19
curl -i -X PATCH \
  https://docs.jay-metadata.com/_mock/apis/product/latest/openapi/shops/config \
  -H 'Content-Type: application/json' \
  -d '{
    "shippingModel": {
      "productShippingCalculationStrategy": "SUM",
      "merchantShippingScale": [
        {
          "orderPriceStart": 0,
          "shippingCost": 399
        }
      ]
    },
    "vat": 19
  }'

Responses

Successfully imported the general configuration of a retailer/e-commerce platform (merchant).

Bodyapplication/json
dataany(The response data)

The response data.

nextTokenstring(Next token)

The token, which can be used to retrieve the next page of data.

errorobject(The error response)

Represents a data response with a possible error.

Response
application/json
{
  "data": null,
  "nextToken": "string",
  "error": {
    "code": 1001,
    "message": "string",
    "details": null
  }
}

Products

Operations

API information

Operations