Extend a custom data definition

PATCH

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

Adds fields and/or relationships to an existing custom data definition. Existing fields and relationships are preserved — this endpoint only appends. To rename or change the definition's name/description, pass them in the body (those fields are updated in place). Existing records are not migrated; new fields read as null until written. The targetField auto-assignment rule applies (see createCustomDataDefinition).

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key, in the form {prefix}.{secret}.

Type

string

Required

Example"a1b2c3d4.xK9pR2mVn6QwErTyUiOpAsDfGhJkLzXcVbNmQwErTyU"

Pattern

"^[a-zA-Z0-9]{8}\\.[A-Za-z0-9_-]+$"

Path Parameters

id_definition*

Unique identifier of the custom data definition to extend.

Type

number

Required

Request Body

application/json

{

  

"name": "product_ratings",

  

"description": "Tracks customer ratings and feedback for products",

  

"fields": [

  

  

{

  

  

  

"name": "product_id",

  

  

  

"label": "Product ID",

  

  

  

"type": "number",

  

  

  

"description": "The unique identifier for the product.",

  

  

  

"required": true,

  

  

  

"default": {

  

  

  

},

  

  

  

"options": [

  

  

  

  

"option 1"

  

  

  

]

  

  

}

  

],

  

"relationships": [

  

  

{

  

  

  

"sourceField": "product_id",

  

  

  

"targetSchemaType": "system",

  

  

  

"targetSchema": "customers",

  

  

  

"targetField": "id_contact"

  

  

}

  

]

}

Responses

Custom data definition extended successfully

Content-Type

application/json

{

  

"statusCode": 201,

  

"data": {

  

  

"id_definition": 1,

  

  

"name": "product_ratings",

  

  

"description": "Tracks customer ratings and feedback for products",

  

  

"unique_keys": [

  

  

  

"product_id"

  

  

],

  

  

"fields": [

  

  

  

{

  

  

  

  

"name": "product_id",

  

  

  

  

"label": "Product ID",

  

  

  

  

"type": "number",

  

  

  

  

"description": "The unique identifier for the product.",

  

  

  

  

"required": true,

  

  

  

  

"default": {

  

  

  

  

},

  

  

  

  

"options": [

  

  

  

  

  

"option 1"

  

  

  

  

]

  

  

  

}

  

  

],

  

  

"relationships": [

  

  

  

{

  

  

  

  

"sourceField": "product_id",

  

  

  

  

"targetSchemaType": "system",

  

  

  

  

"targetSchema": "customers",

  

  

  

  

"targetField": "id_contact"

  

  

  

}

  

  

],

  

  

"status": "active",

  

  

"created_at": "2024-05-17T14:20:19.000Z",

  

  

"updated_at": "2024-05-17T14:20:19.000Z"

  

}

}

PATCH

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

Playground

Headers

spm-api-key*

Variables

Key

Value

id_definition*

Body

Samples

Extend a custom data definition Adds fields and/or relationships to an existing custom data definition. Existing fields and relationships are preserved — this endpoint only appends. To rename or change the definition's name/description, pass them in the body (those fields are updated in place). Existing records are not migrated; new fields read as null until written. The targetField auto-assignment rule applies (see createCustomDataDefinition). PATCH /v1/custom-data-definitions/{id_definition}/extend extendCustomDataDefinition Custom data definitions spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. id_definition Unique identifier of the custom data definition to extend. Custom data definition extended successfully Client error - Invalid request or authentication issues Server error - Internal processing failure