Upsert customers in bulk

POST

https://core.shopimind.com/v1/customers

Creates or updates up to 50 customers in a single request. Each record is matched on customer_id: existing customers are updated, new ones are created. Validation is performed per item — rejected items are returned in rejected_items while valid items are accepted. Processing is asynchronous, so changes may not be immediately visible on subsequent reads.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

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

Request Body

application/json

[

  

{

  

  

"customer_id": "cust_001",

  

  

"shop_id": "shop_id_1",

  

  

"email": "test@test.com",

  

  

"phone_number": "+33612345678",

  

  

"first_name": "John",

  

  

"last_name": "Doe",

  

  

"gender": 1,

  

  

"birth_date": "1990-01-01",

  

  

"is_opt_in": true,

  

  

"is_newsletter_subscribed": true,

  

  

"lang": "en",

  

  

"group_ids": [

  

  

  

[

  

  

  

  

"group_id_1",

  

  

  

  

"group_id_2"

  

  

  

]

  

  

],

  

  

"is_active": true,

  

  

"created_at": "2023-01-29T14:47:00.000Z",

  

  

"updated_at": "2023-01-29T14:47:00.000Z"

  

}

]

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": [

  

]

}

POST

https://core.shopimind.com/v1/customers

Playground

Headers

spm-api-key*

Body

Samples

Upsert customers in bulk Creates or updates up to 50 customers in a single request. Each record is matched on customer_id: existing customers are updated, new ones are created. Validation is performed per item — rejected items are returned in rejected_items while valid items are accepted. Processing is asynchronous, so changes may not be immediately visible on subsequent reads. POST /v1/customers bulkCreateCustomers Customers spm-api-key [Authentication] Required API key. 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