BigCommerce · Schema

customer_Post

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
email string The email of the customer. Must be unique.
first_name string The first name of the customer.
last_name string The last name of the customer.
company string The company of the customer.
phone string The phone number of the customer.
notes string The customer notes.
tax_exempt_category string The tax exempt category code for the customer.
customer_group_id integer ID of the group which this customer belongs to.
addresses array Array of customer addresses. Limited to 10.
attributes array Array of customer attributes. Limited to 10.
authentication object
accepts_product_review_abandoned_cart_emails boolean It determines if the customer is signed up to receive either product review or abandoned cart emails or receive both emails.
store_credit_amounts object
origin_channel_id integer Channel ID of the customer that has created the form.
channel_ids array Array of channels the customer can access.
form_fields array Array of form fields. Controlled by formfields parameter.
View JSON Schema on GitHub

JSON Schema

bigcommerce-customer-post-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/customer_Post",
  "title": "customer_Post",
  "type": "object",
  "properties": {
    "email": {
      "description": "The email of the customer. Must be unique.",
      "type": "string",
      "minLength": 3,
      "maxLength": 255
    },
    "first_name": {
      "description": "The first name of the customer.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "last_name": {
      "description": "The last name of the customer.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "company": {
      "description": "The company of the customer.",
      "type": "string",
      "minLength": 0,
      "maxLength": 255
    },
    "phone": {
      "description": "The phone number of the customer.",
      "type": "string",
      "minLength": 0,
      "maxLength": 50
    },
    "notes": {
      "description": "The customer notes.",
      "type": "string"
    },
    "tax_exempt_category": {
      "description": "The tax exempt category code for the customer.",
      "type": "string",
      "minLength": 0,
      "maxLength": 255
    },
    "customer_group_id": {
      "description": "ID of the group which this customer belongs to.",
      "type": "integer",
      "format": "int32"
    },
    "addresses": {
      "description": "Array of customer addresses. Limited to 10.",
      "type": "array",
      "maxItems": 10,
      "items": {
        "$ref": "#/components/schemas/customerAddresses_CustomerPost"
      }
    },
    "attributes": {
      "description": "Array of customer attributes. Limited to 10.",
      "type": "array",
      "maxItems": 10,
      "items": {
        "$ref": "#/components/schemas/customerAttributes_Base"
      }
    },
    "authentication": {
      "$ref": "#/components/schemas/customerAuthentication_PostPut"
    },
    "accepts_product_review_abandoned_cart_emails": {
      "type": "boolean",
      "description": "It determines if the customer is signed up to receive either product review or abandoned cart emails or receive both emails."
    },
    "store_credit_amounts": {
      "$ref": "#/components/schemas/CustomerStoredCreditAmounts"
    },
    "origin_channel_id": {
      "type": "integer",
      "description": "Channel ID of the customer that has created the form."
    },
    "channel_ids": {
      "description": "Array of channels the customer can access.",
      "type": "array",
      "example": [
        1,
        2
      ],
      "items": {
        "type": "integer"
      }
    },
    "form_fields": {
      "type": "array",
      "description": "Array of form fields. Controlled by formfields parameter.\n",
      "items": {
        "$ref": "#/components/schemas/formFieldValue"
      }
    }
  },
  "required": [
    "email",
    "first_name",
    "last_name"
  ],
  "x-internal": false
}