commercetools Project API

openapi: 3.2.0
info:
  title: commercetools HTTP Project API
  description: The commercetools HTTP API is the core REST interface for programmatic access to all data and functionality within a Composable Commerce project. It covers a broad range of commerce resources including products, product types, categories, carts, orders, customers, payments, discounts, inventory, shipping methods, stores, and business units. All resources follow RESTful conventions using standard HTTP verbs and return JSON responses. Authentication is handled via OAuth 2.0 client credentials, and requests are scoped per project and resource type.
  version: '1.0'
  contact:
    name: commercetools Support
    url: https://support.commercetools.com
  termsOfService: https://commercetools.com/terms-conditions
servers:
- url: https://api.{region}.commercetools.com
  description: Production Server
  variables:
    region:
      default: us-central1.gcp
      enum:
      - us-central1.gcp
      - us-east-2.aws
      - europe-west1.gcp
      - eu-central-1.aws
      - australia-southeast1.gcp
      description: The deployment region for the commercetools API.
security:
- bearerAuth: []
tags:
- name: Project
  description: Read and configure project-level settings including currencies, languages, and messages.
paths:
  /{projectKey}:
    get:
      operationId: getProject
      summary: Get project settings
      description: Retrieves the project settings including languages, currencies, countries, messaging configuration, and search indexing settings. The project key in the path must match the authenticated API client's project.
      tags:
      - Project
      parameters:
      - $ref: '#/components/parameters/projectKey'
      responses:
        '200':
          description: The project settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    projectKey:
      name: projectKey
      in: path
      required: true
      schema:
        type: string
      description: The unique key identifying the commercetools project.
  responses:
    Unauthorized:
      description: The request lacked valid authentication credentials.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
              message:
                type: string
  schemas:
    Project:
      type: object
      description: The project resource containing global configuration for languages, currencies, countries, and features.
      required:
      - key
      - name
      - currencies
      - languages
      - countries
      properties:
        key:
          type: string
          description: The unique project key.
        name:
          type: string
          description: Human-readable name of the project.
        currencies:
          type: array
          items:
            type: string
            pattern: ^[A-Z]{3}$
          description: ISO 4217 currency codes enabled for the project.
        languages:
          type: array
          items:
            type: string
          description: IETF language tags enabled for the project.
        countries:
          type: array
          items:
            type: string
          description: ISO 3166-1 alpha-2 country codes enabled for the project.
        createdAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the project was created.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 Bearer token obtained from the commercetools authentication service at https://auth.{region}.commercetools.com/oauth/token using client credentials flow.
externalDocs:
  description: commercetools HTTP API Documentation
  url: https://docs.commercetools.com/api