Emporix · Schema

CustomerForSellerDto

CompanyCommerceE-CommerceB2B CommerceHeadless CommerceComposable CommerceCommerce OrchestrationAgentic CommerceiPaaSSoftware-as-a-Service

Properties

Name Type Description
title string
firstName string
middleName string
lastName string
contactPhone string
company string
preferredLanguage string Customer preferred language.
preferredCurrency string Customer preferred currency, compliant with the ISO 4217 standard.
preferredSite string Customer preferred site.
type string User type. Supported values are: `CUSTOMER` and `CONTACT`. If the field is empty then the user is considered as a customer.
photoUrl string Url of a picture.
b2b object
metadata object
mixins object Customer account's additional properties. The property is not returned by default. In order to return the mixins property use `expand=mixin:*` query param.
restriction object
customerNumber string Customer unique number generated when the customer profile is created.
id string Customer unique identifier generated when the customer profile is created.
defaultAddress object
accounts array List of accounts associated with the customer profile.
addresses array List of customer addresses.
contactEmail string
active boolean Flag indicating whether the customer profile is active.
onHold boolean Flag indicating whether the customer profile is suspended.
email string Customer email address.
businessModel string Property indicating business model of customer. When customer is assigned to any company then it is `B2B`. Otherwise it is `B2C`.
metadataCreatedAt string Customer creation date.
View JSON Schema on GitHub

JSON Schema

emporix-customer-for-seller-dto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/emporix/main/json-schema/emporix-customer-for-seller-dto-schema.json",
  "title": "CustomerForSellerDto",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/emporix-customer-service-openapi.yml#/components/schemas/CustomerForSellerDto",
  "allOf": [
    {
      "$ref": "#/$defs/CustomerCommonDto"
    },
    {
      "type": "object",
      "properties": {
        "customerNumber": {
          "type": "string",
          "description": "Customer unique number generated when the customer profile is created."
        },
        "id": {
          "type": "string",
          "description": "Customer unique identifier generated when the customer profile is created."
        },
        "defaultAddress": {
          "$ref": "#/$defs/Address"
        },
        "accounts": {
          "type": "array",
          "description": "List of accounts associated with the customer profile.",
          "items": {
            "$ref": "#/$defs/AccountId"
          }
        },
        "addresses": {
          "type": "array",
          "description": "List of customer addresses.",
          "items": {
            "$ref": "#/$defs/Address"
          }
        },
        "contactEmail": {
          "type": "string"
        },
        "active": {
          "type": "boolean",
          "description": "Flag indicating whether the customer profile is active."
        },
        "onHold": {
          "type": "boolean",
          "description": "Flag indicating whether the customer profile is suspended."
        },
        "email": {
          "type": "string",
          "description": "Customer email address."
        },
        "b2b": {
          "allOf": [
            {
              "$ref": "#/$defs/B2BGet"
            }
          ]
        },
        "businessModel": {
          "type": "string",
          "enum": [
            "B2B",
            "B2C"
          ],
          "description": "Property indicating business model of customer. When customer is assigned to any company then it is `B2B`. Otherwise it is `B2C`."
        },
        "metadataCreatedAt": {
          "type": "string",
          "description": "Customer creation date."
        }
      }
    }
  ],
  "$defs": {
    "AccountId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Customer email address."
        },
        "providerId": {
          "type": "string",
          "description": "Customer account unique identifier generated by an external identity provider.\n\n**Note**: This field is only applicable if the user has been registered through social login."
        }
      }
    },
    "Address": {
      "type": "object",
      "description": "Customer address information.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Customer address unique identifier generated when the address is added to the customer account."
        },
        "contactName": {
          "type": "string"
        },
        "companyName": {
          "type": "string"
        },
        "street": {
          "type": "string"
        },
        "streetNumber": {
          "type": "string"
        },
        "streetAppendix": {
          "type": "string"
        },
        "extraLine1": {
          "type": "string"
        },
        "extraLine2": {
          "type": "string"
        },
        "extraLine3": {
          "type": "string"
        },
        "extraLine4": {
          "type": "string"
        },
        "zipCode": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "maxLength": 2,
          "minLength": 2
        },
        "state": {
          "type": "string"
        },
        "contactPhone": {
          "type": "string"
        },
        "isDefault": {
          "type": "boolean",
          "default": false,
          "description": "Flag indicating whether the address is the customer default address."
        },
        "tags": {
          "type": "array",
          "description": "",
          "items": {
            "type": "string"
          }
        },
        "metadata": {
          "$ref": "#/$defs/DefaultDtoMetadata"
        },
        "mixins": {
          "type": "object",
          "description": "Customer address additional properties.",
          "additionalProperties": true
        }
      },
      "required": [
        "contactName"
      ]
    },
    "B2BCreate": {
      "type": "object",
      "description": "Additional properties for B2B customer.",
      "properties": {
        "companyRegistrationId": {
          "type": "string",
          "description": "Registration number of the company."
        }
      }
    },
    "B2BGet": {
      "allOf": [
        {
          "$ref": "#/$defs/B2BCreate"
        }
      ],
      "properties": {
        "legalEntities": {
          "type": "array",
          "items": {
            "properties": {
              "id": {
                "type": "string",
                "description": "ID of legal entity."
              },
              "name": {
                "type": "string",
                "description": "Name of legal entity."
              },
              "contactAssignmentId": {
                "type": "string",
                "description": "ID of contact assignment."
              }
            }
          }
        }
      }
    },
    "BasicMetadataDto": {
      "title": "DefaultDtoMetadata",
      "type": "object",
      "properties": {
        "mixins": {
          "type": "object",
          "additionalProperties": true
        }
      },
      "description": "Links to mixin schemas."
    },
    "CustomerCommonDto": {
      "type": "object",
      "allOf": [
        {
          "$ref": "#/$defs/CustomerCreateDto"
        },
        {
          "type": "object",
          "properties": {
            "metadata": {
              "$ref": "#/$defs/DefaultDtoMetadata"
            }
          }
        }
      ]
    },
    "CustomerCreateDto": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "firstName": {
          "type": "string"
        },
        "middleName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "contactPhone": {
          "type": "string"
        },
        "company": {
          "type": "string"
        },
        "preferredLanguage": {
          "type": "string",
          "default": "en_US",
          "description": "Customer preferred language."
        },
        "preferredCurrency": {
          "type": "string",
          "default": "USD",
          "description": "Customer preferred currency, compliant with the ISO 4217 standard.",
          "minLength": 3,
          "maxLength": 3
        },
        "preferredSite": {
          "type": "string",
          "default": "main",
          "description": "Customer preferred site."
        },
        "type": {
          "type": "string",
          "description": "User type. Supported values are: `CUSTOMER` and `CONTACT`. If the field is empty then the user is considered as a customer."
        },
        "photoUrl": {
          "type": "string",
          "description": "Url of a picture."
        },
        "b2b": {
          "allOf": [
            {
              "$ref": "#/$defs/B2BCreate"
            }
          ]
        },
        "metadata": {
          "$ref": "#/$defs/BasicMetadataDto"
        },
        "mixins": {
          "type": "object",
          "description": "Customer account's additional properties. The property is not returned by default. In order to return the mixins property use `expand=mixin:*` query param.",
          "additionalProperties": true
        },
        "restriction": {
          "$ref": "#/$defs/Restriction"
        }
      }
    },
    "DefaultDtoMetadata": {
      "title": "DefaultDtoMetadata",
      "type": "object",
      "allOf": [
        {
          "$ref": "#/$defs/BasicMetadataDto"
        },
        {
          "type": "object",
          "properties": {
            "version": {
              "type": "integer"
            }
          }
        }
      ]
    },
    "Restriction": {
      "type": [
        "string",
        "null"
      ],
      "description": "Access control identifier that determines who can view or manage the customer.\n\n**Purpose**: Restricts customer visibility based on scope permissions. Only users/applications \nwith matching restriction scopes can access customers with a specific restriction value.\n\n**Access Control**:\n- *Reading*: Users can only query and view customers with the `restriction` value that matches one of their authorized restrictions.\n\n**Validation**: The value must exist in the tenant's configured list of valid restrictions.\n\n**Site Synchronization**: If the `restriction` property is not set with tenant configuration property `enableSyncBetweenRestrictionsAndSiteCodes` set to `true`, the `restriction` field automatically syncs with `preferredSite` property.\n"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/emporix-customer-for-seller-dto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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