Skip to content
API Reference
/
/
Get Custom Entity Metadat...

Get Custom Entity Metadata

Request

The metadata is a JSON Schema document that describes the implicit and custom properties exposed by the specified Custom Entity resource. The schema should be consulted to build requests against the other Custom Entity endpoints (which fields can be used in $select, $filter, $orderby, request bodies, etc.).

Authentication

Requires a valid API key in the X-API-KEY header.

Response

200 OK — Returns the JSON Schema as a ServiceDocumentRepresentation.

Error Responses

  • 401 Unauthorized — Missing or invalid API key. Returned by the API gateway as { "message": "Unauthorized", "request_id": "d8aafa5b8f3e400b60bea0123dd33317" }.
  • 404 Not Found — Tenant or Custom Entity not found.
  • 500 Internal Server Error — Unexpected technical error.

Example

Request:

GET /CustomEntities('Brand')/$metadata HTTP/1.1
X-API-KEY: your-api-key-here

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Path
customEntityDenominatorstringrequired

Custom Entity denominator (natural language name as defined in the PIM)

Headers
X-API-KEYstring

Tenant's API key (required)

GET
/CustomEntities('{customEntityDenominator}')/$metadata
curl -i -X GET \
  'https://api2.saleslayer.com/catalog/CustomEntities('\''{customEntityDenominator}'\'')/$metadata' \
  -H 'X-API-KEY: string'

Responses

OK

Bodyapplication/json
valueany or null
Response
{
  "readLink": {
    "uri": "http://example.com"
  },
  "value": null
}