Lister les définitions de données personnalisées

GET

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

Retourne une liste paginée de vos définitions de données personnalisées, triée par date de création par défaut. Chaque élément inclut ses fields et relationships. Les paramètres filters, order, limit, offset et fields permettent d'affiner la réponse. À utiliser pour découvrir les schémas disponibles avant lecture ou écriture d'enregistrements.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

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

Query Parameters

limit

Maximum number of records to return

Type

number

Example10

offset

Number of records to skip

Type

number

Example0

order

Sorting criteria, array of objects with field and type properties

Type

array

Examples

{ "field": "created_at", "type": "desc" }

fields

Fields to include in the response, comma-separated or array

Examples

"id,name,created_at"

filters

Filter criteria, array of objects with field, operator and values properties.

Available operators: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, LESS_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, IN, NOT_IN, LIKE, BETWEEN, NOT_BETWEEN

Type

array

Examples

{ "field": "status", "operator": "EQUALS", "values": "active" }

Responses

Paginated listing response.

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"

  

  

}

  

],

  

"meta": {

  

  

"pagination": {

  

  

  

"total_items": 100,

  

  

  

"items_per_page": 10,

  

  

  

"total_pages": 10,

  

  

  

"current_page": 1,

  

  

  

"offset": 0,

  

  

  

"has_previous_page": false,

  

  

  

"has_next_page": true,

  

  

  

"next_page": 2,

  

  

  

"previous_page": 0

  

  

},

  

  

"generated_at": "2024-05-06T14:32:11.000Z"

  

}

}

GET

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

Playground

Headers

spm-api-key*

Variables

Key

Value

limit

offset

order

fields

filters

Samples

Lister les définitions de données personnalisées Retourne une liste paginée de vos définitions de données personnalisées, triée par date de création par défaut. Chaque élément inclut ses fields et relationships. Les paramètres filters, order, limit, offset et fields permettent d'affiner la réponse. À utiliser pour découvrir les schémas disponibles avant lecture ou écriture d'enregistrements. GET /v1/custom-data-definitions listCustomDataDefinitions Custom data definitions spm-api-key [Authentication] Required API key. limit Maximum number of records to return offset Number of records to skip order Sorting criteria, array of objects with field and type properties fields Fields to include in the response, comma-separated or array filters Filter criteria, array of objects with field, operator and values properties. Available operators: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, LESS_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, IN, NOT_IN, LIKE, BETWEEN, NOT_BETWEEN Paginated listing response.