CustomerForSellerDto

{
  "$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"
    }
  }
}