Retrieve a customer

GET

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

Retrieves the details of an existing customer. Use the fields parameter to restrict the returned attributes.

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 as provided by the merchant shop in bulkCreateCustomers (alphanumeric, dashes and underscores).

Type

string

Required

Query Parameters

fields

Subset of customer fields to return. Repeat the parameter or pass a comma-separated string.

Type

array

Valid values

"customer_id""shop_id""email""phone_number""first_name""last_name""birth_date""is_opt_in""is_newsletter_subscribed""lang""group_ids""is_active""created_at""updated_at"

Responses

Resource successfully retrieved.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": {

  

  

"customer_id": "cust_001",

  

  

"email": "customer@example.com",

  

  

"first_name": "Marie",

  

  

"last_name": "Dupont",

  

  

"phone": "+33612345678",

  

  

"lang": "fr",

  

  

"is_newsletter_subscriber": true,

  

  

"created_at": "2024-01-15T08:00:00.000Z",

  

  

"updated_at": "2024-04-30T18:25:00.000Z"

  

}

}

GET

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

Playground

Headers

spm-api-key*

Variables

Key

Value

customer_id*

fields

Samples

Retrieve a customer Retrieves the details of an existing customer. Use the fields parameter to restrict the returned attributes. GET /v1/customers/{customer_id} getCustomer Customers spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. customer_id Customer identifier as provided by the merchant shop in bulkCreateCustomers (alphanumeric, dashes and underscores). fields Subset of customer fields to return. Repeat the parameter or pass a comma-separated string. Resource successfully retrieved. Client error - Invalid request or authentication issues Server error - Internal processing failure