BigCommerce · Schema

address_Put

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
first_name string The first name of the customer address.
last_name string The last name of the customer address.
company string The company of the customer address.
address1 string The address 1 line.
address2 string The address 2 line.
city string The city of the customer address.
state_or_province string The state or province name.
postal_code string The postal code of the customer address.
country_code string The country code of the customer address.
phone string The phone number of the customer address.
address_type string The address type. Residential or Commercial.
id integer The unique numeric ID of the address.
form_fields array Array of form fields. Controlled by formfields parameter.
View JSON Schema on GitHub

JSON Schema

bigcommerce-address-put-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/address_Put",
  "title": "address_Put",
  "type": "object",
  "properties": {
    "first_name": {
      "description": "The first name of the customer address.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "last_name": {
      "description": "The last name of the customer address.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "company": {
      "description": "The company of the customer address.",
      "type": "string",
      "minLength": 0,
      "maxLength": 255
    },
    "address1": {
      "description": "The address 1 line.",
      "type": "string"
    },
    "address2": {
      "description": "The address 2 line.",
      "type": "string"
    },
    "city": {
      "description": "The city of the customer address.",
      "type": "string",
      "minLength": 0,
      "maxLength": 100
    },
    "state_or_province": {
      "description": "The state or province name.",
      "type": "string",
      "minLength": 0,
      "maxLength": 100,
      "example": "California"
    },
    "postal_code": {
      "description": "The postal code of the customer address.",
      "type": "string",
      "minLength": 0,
      "maxLength": 30
    },
    "country_code": {
      "description": "The country code of the customer address.",
      "type": "string",
      "minLength": 2,
      "maxLength": 2,
      "example": "US"
    },
    "phone": {
      "description": "The phone number of the customer address.",
      "type": "string",
      "minLength": 0,
      "maxLength": 50
    },
    "address_type": {
      "title": "Address Type",
      "description": "The address type. Residential or Commercial.",
      "example": "residential",
      "type": "string",
      "enum": [
        "residential",
        "commercial"
      ]
    },
    "id": {
      "description": "The unique numeric ID of the address.",
      "type": "integer",
      "format": "int32",
      "example": 1
    },
    "form_fields": {
      "type": "array",
      "description": "Array of form fields. Controlled by formfields parameter.\n",
      "items": {
        "$ref": "#/components/schemas/formFieldValue"
      }
    }
  },
  "required": [
    "id"
  ],
  "x-examples": {
    "example-1": {
      "value": [
        {
          "id": 18,
          "first_name": "sam"
        }
      ]
    }
  },
  "x-internal": false
}