Skip to main content
API docs by Redocly

Customer Profile Admin API (0.0.1)

Download OpenAPI specification:Download

Use this API to internally manage customers in the NewStore plaform. A customer is identified by a customer id in NewStore.

Note: Typically, customers are created automatically when they place an order online or when they provide their email address during an in-store purchase.

Related resources:

Manage customer profiles

Use this resource to manage customer profiles in the NewStore platform.

Merge profiles

Merges two customer profiles into one profile.

The data from specific fields from the source profile is merged into the target profile using this method.

The fields that can be merged include:

  • first_name
  • last_name
  • phone_number
  • extended_attributes
  • address

When the data is merged and the operation is complete, the source profile is deleted automatically.

Authorizations:
bearerAuth
Request Body schema: application/json
source_profile_id
required
string

ID of the source profile.

target_profile_id
required
string

ID of the target profile.

Responses

Request samples

Content type
application/json
{
  • "source_profile_id": "string",
  • "target_profile_id": "string"
}

Response samples

Content type
application/json
{
  • "source_profile": { },
  • "target_profile": { }
}

Get customer

Returns the customer matching the specified ID.

Authorizations:
bearerAuth
path Parameters
email
required
string

To retrieve the customer by email.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "phone_number": "string",
  • "country_code": "string",
  • "addresses": [
    ],
  • "extended_attributes": [
    ],
  • "created_by": "string",
  • "created_by_name": "string",
  • "store_id": "string",
  • "store_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "revision": 0,
  • "display_id": "string"
}