Retrieve a custom data definition

GET

https://core.shopimind.com/v1/custom-data-definitions/{id_definition}

Retrieves the details of an existing custom data definition, including its fields, unique keys, relationships, and current status.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

"^[a-zA-Z0-9-]{20,64}$"

Path Parameters

id_definition*

Unique identifier of the custom data definition to retrieve.

Type

string

Required

Responses

Resource successfully retrieved.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": {

  

  

"id_definition": 42,

  

  

"name": "pet_profile",

  

  

"description": "Pet metadata attached to a customer",

  

  

"status": "active",

  

  

"fields": [

  

  

  

{

  

  

  

}

  

  

],

  

  

"relationships": [

  

  

  

{

  

  

  

}

  

  

],

  

  

"unique_keys": [

  

  

  

[

  

  

  

  

"species",

  

  

  

  

"owner_id"

  

  

  

]

  

  

],

  

  

"created_at": "2024-02-01T10:00:00.000Z"

  

}

}

GET

https://core.shopimind.com/v1/custom-data-definitions/{id_definition}

Playground

Headers

spm-api-key*

Variables

Key

Value

id_definition*

Samples

Retrieve a custom data definition Retrieves the details of an existing custom data definition, including its fields, unique keys, relationships, and current status. GET /v1/custom-data-definitions/{id_definition} getCustomDataDefinition Custom data definitions spm-api-key [Authentication] Required API key. id_definition Unique identifier of the custom data definition to retrieve. Resource successfully retrieved. Client error - Invalid request or authentication issues Server error - Internal processing failure