Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Newstore profiles API

Clienteling Profiles

Newstore profiles API is one of 42 APIs that Newstore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include profiles. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://dodici-demo.p.newstore.net.

2 operations 2 paths 6 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://dodici-demo.p.newstore.net
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Newstore profiles API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth) using the application flow, exposing 29 scopes.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

profiles 2

Clienteling Profiles

GET
/clienteling/profiles
listProfiles
listProfiles 2 params → default200429500502503
GET
/clienteling/profiles/{customer_id}
showProfile
showProfile 1 param → default200429500502503

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Problem (9 properties), Profile (5 properties), OptedIn (2 properties), Profiles (2 properties). Each schema is shown below with its type and property counts.

Problem
object
9 properties
OptInState
string
The current opt-in state for this store.
Meta
object
Additional response information.
1 property 1 required
Profiles
object
Clienteling profile information for multiple customers.
2 properties 2 required
Profile
object
Clienteling profile information for a customer.
5 properties 5 required
OptedIn
object
Opt-in status information for a conversation between a customer and a store.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newstore-profiles-api-openapi.yml Raw ↑

Other APIs Newstore publishes across the network.

Newstore address API
Newstore audit-events API
Newstore cart API
Newstore cashboxes API
Newstore customer-configuration API
Newstore customer-profile API
Newstore customerProfile API
Newstore data API
Newstore EasypostAdapterConfig API
Newstore external-public API
Newstore fulfillment-requests API
Newstore identity-providers API