Upsert customer addresses across customers

POST

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

Creates or updates up to 50 addresses across any number of customers in a single request. Each item carries its own customer_id and address_id pair, which acts as the upsert key. Items referencing an unknown customer_id are returned in rejected_items. Processing is asynchronous.

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": "1",

  

  

"address_id": 1,

  

  

"first_name": "John",

  

  

"last_name": "Doe",

  

  

"primary_phone": "+33612345678",

  

  

"secondary_phone": "+33612345678",

  

  

"company": "Company Inc.",

  

  

"address_line_1": "1, rue de la Paix",

  

  

"address_line_2": "Apt 123",

  

  

"postal_code": "12345",

  

  

"city": "Paris",

  

  

"country": "FR",

  

  

"is_active": true

  

}

]

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/addresses/bulk

Playground

Headers

spm-api-key*

Body

Samples

Upsert customer addresses across customers Creates or updates up to 50 addresses across any number of customers in a single request. Each item carries its own customer_id and address_id pair, which acts as the upsert key. Items referencing an unknown customer_id are returned in rejected_items. Processing is asynchronous. POST /v1/customers/addresses/bulk bulkCreateCustomerAddresses 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