How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
commercetools

commercetools Customers API

Manage customer accounts, addresses, authentication, and group assignments.

Documentation Provider Profile APIs.io OpenAPI GitHub

commercetools Customers API is one of 19 APIs that commercetools publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

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

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

Requests are made against 2 base URLs: https://api.{region}.commercetools.com, https://import.{region}.commercetools.com.

6 operations 3 paths 20 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.{region}.commercetools.com
Authentication
HTTP Bearer
Contact
commercetools Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

commercetools Customers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token obtained from the commercetools authentication service at https://auth.{region}.commercetools.com/oauth/token using client credentials f…

Paths & Operations 6

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

Customers 6

Manage customer accounts, addresses, authentication, and group assignments.

GET
/{projectKey}/customers
List customers
listCustomers 6 params → 200401
POST
/{projectKey}/customers
Create a customer
createCustomer 1 param body → 201400
GET
/{projectKey}/customers/{id}
Get a customer by ID
getCustomerById 3 params → 200404
POST
/{projectKey}/customers/{id}
Update a customer by ID
updateCustomerById 2 params body → 200
DELETE
/{projectKey}/customers/{id}
Delete a customer by ID
deleteCustomerById 3 params → 200
POST
/{projectKey}/customers/import-containers/{importContainerKey}
Import customers
importCustomers 2 params body → 201400

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Cart (16 properties), Address (12 properties), Customer (12 properties), LineItem (9 properties). Each schema is shown below with its type and property counts.

Address
object
A postal address with country and optional structured fields.
12 properties 1 required
Reference
object
A reference to another resource by its typeId and id.
2 properties 2 required
Cart
object
A shopping cart resource containing line items, discounts, shipping configuration, and pricing.
16 properties 6 required
CustomerDraft
object
Request body for creating a new customer.
8 properties 2 required
Attribute
object
A name-value pair representing a product attribute as defined by the product type.
2 properties 2 required
Price
object
A price entry for a product variant with optional scoping by channel, customer group, country, or validity period.
7 properties 2 required
LocalizedString
object
A map of locale keys to string values used for multilingual content. Keys follow IETF language tag format (e.g., 'en', 'de', 'en-US').
LineItem
object
A product line item in a cart or order with quantity, pricing, and discount information.
9 properties 9 required
CustomerPagedQueryResponse
object
Paginated response containing a list of customers.
5 properties 5 required
Money
object
A monetary value with currency code and amount in the smallest currency unit.
3 properties 2 required
Customer
object
A customer account with authentication credentials, addresses, and commerce profile data.
12 properties 5 required
CustomerUpdate
object
Request body for updating a customer.
2 properties 2 required
Image
object
A product image with URL, dimensions, and optional label.
3 properties 2 required
CustomerSignInResult
object
The result of a customer creation or sign-in operation, including the customer and any merged cart.
2 properties 1 required
ProductVariant
object
A product variant with SKU, attributes, prices, and images.
6 properties 1 required
ImportResponse
object
The response returned after submitting an import request batch.
1 property 1 required
CustomerImportRequest
object
A batch of customer resources to import.
2 properties 2 required
ErrorObject
object
An error object describing a validation or processing failure.
2 properties 2 required
CustomerImport
object
A single customer resource for import.
7 properties 2 required
ImportOperationStatus
object
The initial status of a single resource submission in an import batch.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

commercetools-customers-api-openapi.yml Raw ↑

Other APIs commercetools publishes across the network.

Commercetools GraphQL API
AE Profile APIs.io
Commercetools TypeScript SDK
AE Profile APIs.io
Commercetools Java SDK
AE Profile APIs.io
Commercetools Checkout API
AE Profile APIs.io
Commercetools Merchant Center Customizations API
AE Profile APIs.io
commercetools Carts API
AE Profile APIs.io
commercetools Categories API
AE Profile APIs.io
commercetools ChangeHistory API
AE Profile APIs.io
commercetools ImportContainers API
AE Profile APIs.io
commercetools ImportOperations API
AE Profile APIs.io
commercetools Inventory API
AE Profile APIs.io
commercetools Orders API
AE Profile APIs.io
#Customers
← Back to C APIs
API Details
ID
commercetools:commercetools-customers-api
Base URL
https://api.{region}.commercetools.com
Docs
https://docs.commercetools.com/api
Provider
commercetools
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=commercetools-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/commercetools-customers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of commercetools Customers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.