BigCommerce · Schema

customer_Full

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
id	integer	Unique numeric ID of this customer. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
_authentication	object	Not returned in any responses, but accepts up to two fields allowing you to set the customer’s password. If a password is not supplied, it is generated automatically. For further information about usi
company	string	The name of the company for which the customer works.
first_name	string	First name of the customer.
last_name	string	Last name of the customer.
email	string	Email address of the customer.
phone	string	Phone number of the customer.
date_created	string	Date on which the customer registered from the storefront or was created in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
date_modified	string	Date on which the customer updated their details in the storefront or was updated in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
store_credit	string	The amount of credit the customer has. (Float, Float as String, Integer)
registration_ip_address	string	The customer’s IP address when they signed up.
customer_group_id	integer	The group to which the customer belongs.
notes	string	Store-owner notes on the customer.
tax_exempt_category	string	If applicable, the tax-exempt category of the shopperʼs customer account. You can apply a tax-exempt category to multiple customers. This code should match the exemption codes provided by the third-pa
accepts_marketing	boolean	Records whether the customer would like to receive marketing content from this store. READ-ONLY.This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
addresses	object
form_fields	array	Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
reset_pass_on_login	boolean	Force a password change on next login.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/customer_Full",
  "title": "customer_Full",
  "required": [
    "email",
    "first_name",
    "last_name"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique numeric ID of this customer. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.",
      "readOnly": true,
      "example": 1
    },
    "_authentication": {
      "type": "object",
      "properties": {
        "force_reset": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "password_confirmation": {
          "type": "string"
        }
      },
      "description": "Not returned in any responses, but accepts up to two fields allowing you to set the customer\u2019s password. If a password is not supplied, it is generated automatically. For further information about using this object, please see the Customers resource documentation."
    },
    "company": {
      "type": "string",
      "description": "The name of the company for which the customer works.",
      "example": "BigCommerce"
    },
    "first_name": {
      "type": "string",
      "description": "First name of the customer.",
      "example": "Jane"
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the customer.",
      "example": "Doe"
    },
    "email": {
      "type": "string",
      "description": "Email address of the customer.",
      "example": "[email protected]"
    },
    "phone": {
      "type": "string",
      "description": "Phone number of the customer.",
      "example": "1234567890"
    },
    "date_created": {
      "type": "string",
      "description": "Date on which the customer registered from the storefront or was created in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.",
      "readOnly": true,
      "format": "date-time"
    },
    "date_modified": {
      "type": "string",
      "description": "Date on which the customer updated their details in the storefront or was updated in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.\n",
      "readOnly": true,
      "format": "date-time"
    },
    "store_credit": {
      "type": "string",
      "description": "The amount of credit the customer has. (Float, Float as String, Integer)",
      "example": "0"
    },
    "registration_ip_address": {
      "type": "string",
      "description": "The customer\u2019s IP address when they signed up.",
      "example": "12.345.678.910"
    },
    "customer_group_id": {
      "type": "integer",
      "description": "The group to which the customer belongs.",
      "example": 2
    },
    "notes": {
      "type": "string",
      "description": "Store-owner notes on the customer."
    },
    "tax_exempt_category": {
      "type": "string",
      "description": "If applicable, the tax-exempt category of the shopper\u02bcs customer account. You can apply a tax-exempt category to multiple customers. This code should match the exemption codes provided by the third-party integration."
    },
    "accepts_marketing": {
      "type": "boolean",
      "description": "Records whether the customer would like to receive marketing content from this store. READ-ONLY.This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.\n",
      "readOnly": true,
      "example": true
    },
    "addresses": {
      "$ref": "#/components/schemas/addresses"
    },
    "form_fields": {
      "type": "array",
      "description": "Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/formField"
      }
    },
    "reset_pass_on_login": {
      "type": "boolean",
      "description": "Force a password change on next login.",
      "example": false
    }
  },
  "x-internal": false
}