WooCommerce · JSON Structure

Woocommerce Store Api Store Address Structure

A customer billing or shipping address in the Store API context.

Type: object Properties: 11
eCommerceOpen SourceOrdersProductsWordPress

StoreAddress is a JSON Structure definition published by WooCommerce, describing 11 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

first_name last_name company address_1 address_2 city state postcode country email phone

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-structure/woocommerce-store-api-store-address-structure.json",
  "name": "StoreAddress",
  "description": "A customer billing or shipping address in the Store API context.",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "First name.",
      "example": "Example Name"
    },
    "last_name": {
      "type": "string",
      "description": "Last name.",
      "example": "Example Name"
    },
    "company": {
      "type": "string",
      "description": "Company name.",
      "example": "string-value"
    },
    "address_1": {
      "type": "string",
      "description": "Address line 1.",
      "example": "string-value"
    },
    "address_2": {
      "type": "string",
      "description": "Address line 2.",
      "example": "string-value"
    },
    "city": {
      "type": "string",
      "description": "City.",
      "example": "string-value"
    },
    "state": {
      "type": "string",
      "description": "State or province code.",
      "example": "string-value"
    },
    "postcode": {
      "type": "string",
      "description": "Postal code.",
      "example": "string-value"
    },
    "country": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 country code.",
      "example": "string-value"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address (billing only).",
      "example": "user@example.com"
    },
    "phone": {
      "type": "string",
      "description": "Phone number.",
      "example": "string-value"
    }
  }
}