Update a customer's addresses

PUT

https://core.shopimind.com/v1/customers/{customer_id}/addresses

Updates up to 50 existing addresses of the specified customer. Addresses are matched on address_id; unknown ones are returned in rejected_items. Only the fields provided in each item are modified; omitted fields are left unchanged. Processing is asynchronous.

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

customer_id*

Customer identifier owning the addresses.

Type

string

Required

Request Body

application/json

[

  

{

  

  

"address_id": 1001,

  

  

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

  

]

}

PUT

https://core.shopimind.com/v1/customers/{customer_id}/addresses

Playground

Headers

spm-api-key*

Variables

Key

Value

customer_id*

Body

Samples

Update a customer's addresses Updates up to 50 existing addresses of the specified customer. Addresses are matched on address_id; unknown ones are returned in rejected_items. Only the fields provided in each item are modified; omitted fields are left unchanged. Processing is asynchronous. PUT /v1/customers/{customer_id}/addresses updateCustomerAddresses Customers spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. customer_id Customer identifier owning the addresses. 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