BigCommerce · Schema

ValidateCustomerCredentialsObject

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
email	string	Customer email address.
password	string	Customer password.
channel_id	integer	ChannelId to check the customer credentials against - If this field is empty we will use channel 1.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ValidateCustomerCredentialsObject",
  "title": "ValidateCustomerCredentialsObject",
  "type": "object",
  "required": [
    "email",
    "password"
  ],
  "properties": {
    "email": {
      "type": "string",
      "description": "Customer email address."
    },
    "password": {
      "type": "string",
      "description": "Customer password."
    },
    "channel_id": {
      "type": "integer",
      "description": "ChannelId to check the customer credentials against - If this field is empty we will use channel 1."
    }
  },
  "x-internal": false
}