Delete a custom data record

DELETE

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

Permanently deletes a single record from the definition id_definition. The record is identified by the id query parameter (the record's auto-incremented primary key, returned by listCustomDataRecords). Processing is asynchronous.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

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

Path Parameters

id_definition*

ID of the custom data definition to target.

Type

string

Required

Query Parameters

id*

The auto-incremented ID of the record to delete. Example: /custom-data-records/42?id=123

Type

number

Required

Responses

Objects have been sent to the processing queue. Partially invalid objects are rejected and returned in rejected_items.

Content-Type

application/json

{

  

"statusCode": 200,

  

"sent_count": 5,

  

"rejected_count": 0,

  

"rejected_items": [

  

]

}

DELETE

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

Playground

Headers

spm-api-key*

Variables

Key

Value

id_definition*

id*

Samples

Delete a custom data record Permanently deletes a single record from the definition id_definition. The record is identified by the id query parameter (the record's auto-incremented primary key, returned by listCustomDataRecords). Processing is asynchronous. DELETE /v1/custom-data-records/{id_definition} deleteCustomDataRecord Custom data records spm-api-key [Authentication] Required API key. id The auto-incremented ID of the record to delete. Example: /custom-data-records/42?id=123 id_definition ID of the custom data definition to target. Objects have been sent to the processing queue. Partially invalid objects are rejected and returned in rejected_items. All objects are invalid, or the request body is not an array, or the array exceeds the maximum allowed size Server error - Internal processing failure