> ## Documentation Index
> Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an Address

> Creates an Address



## OpenAPI

````yaml /api-reference/platform.yaml post /api/v2/platform/addresses
openapi: 3.0.3
info:
  title: Platform API
  contact:
    name: Vendo Connect Inc.
    url: https://getvendo.com
    email: sales@getvendo.com
  description: Spree Platform API
  version: v2
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Addresses
  - name: Adjustments
  - name: Classifications
  - name: Countries
  - name: CMS Pages
  - name: CMS Sections
  - name: Digital Assets
  - name: Digital Links
  - name: Line Items
  - name: Menus
  - name: Menu Items
  - name: Option Types
  - name: Option Values
  - name: Orders
  - name: Payments
  - name: Payment Methods
  - name: Products
  - name: Promotions
  - name: Promotion Actions
  - name: Promotion Categories
  - name: Promotion Rules
  - name: Roles
  - name: Shipments
  - name: Shipping Categories
  - name: Shipping Methods
  - name: States
  - name: Stock Items
  - name: Stock Locations
  - name: Store Credit Categories
  - name: Store Credit Types
  - name: Store Credits
  - name: Tax Categories
  - name: Tax Rates
  - name: Taxons
  - name: Taxonomies
  - name: Users
  - name: Variants
  - name: Vendors
  - name: Webhook Events
  - name: Webhook Subscribers
  - name: Wishlists
  - name: Wished Items
  - name: Zones
paths:
  /api/v2/platform/addresses:
    post:
      tags:
        - Addresses
      summary: Create an Address
      description: Creates an Address
      operationId: create-address
      parameters:
        - name: include
          in: query
          description: >-
            Select which associated resources you would like to fetch, see: <a
            href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
          example: user,country,state
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_address_params'
      responses:
        '201':
          description: Record created
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                      id: '5'
                      type: address
                      attributes:
                        firstname: John
                        lastname: Doe
                        address1: 5 Lovely Street
                        address2: Northwest
                        city: Herndon
                        zipcode: '35005'
                        phone: 555-555-0199
                        state_name: null
                        alternative_phone: 555-555-0199
                        company: Company
                        created_at: '2022-11-08T19:33:51.471Z'
                        updated_at: '2022-11-08T19:33:51.471Z'
                        deleted_at: null
                        label: null
                        public_metadata: {}
                        private_metadata: {}
                      relationships:
                        country:
                          data:
                            id: '4'
                            type: country
                        state:
                          data:
                            id: '5'
                            type: state
                        user:
                          data:
                            id: '1'
                            type: user
              schema:
                $ref: '#/components/schemas/resource'
        '422':
          description: Invalid request
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: >-
                      First Name can't be blank, Last Name can't be blank,
                      Address can't be blank, City can't be blank, Country can't
                      be blank, Zip Code can't be blank, and Phone can't be
                      blank
                    errors:
                      firstname:
                        - can't be blank
                      lastname:
                        - can't be blank
                      address1:
                        - can't be blank
                      city:
                        - can't be blank
                      country:
                        - can't be blank
                      zipcode:
                        - can't be blank
                      phone:
                        - can't be blank
              schema:
                $ref: '#/components/schemas/validation_errors'
      security:
        - bearer_auth: []
components:
  schemas:
    create_address_params:
      type: object
      properties:
        address:
          type: object
          required:
            - country_id
            - address1
            - city
            - zipcode
            - phone
            - firstname
            - lastname
          properties:
            country_id:
              type: string
              example: '224'
            state_id:
              type: string
              example: '516'
            state_name:
              type: string
              example: New York
            address1:
              type: string
              example: 5th ave
            address2:
              type: string
              example: 1st suite
            city:
              type: string
              example: NY
            zipcode:
              type: string
              example: '10001'
            phone:
              type: string
              example: +1 123 456 789
            alternative_phone:
              type: string
            firstname:
              type: string
              example: John
            lastname:
              type: string
              example: Snow
            label:
              type: string
              example: My home address
            company:
              type: string
              example: Vendo Connect Inc
            user_id:
              type: string
            public_metadata:
              type: object
              example:
                distance_from_nearest_city_in_km: 10
                location_type: building
            private_metadata:
              type: object
              example:
                close_to_shop: true
      required:
        - address
      x-internal: false
    resource:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/resource_properties'
      required:
        - data
      x-internal: false
    validation_errors:
      type: object
      properties:
        error:
          type: string
        errors:
          type: object
      required:
        - error
        - errors
      x-internal: false
    resource_properties:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
        relationships:
          type: object
      required:
        - id
        - type
        - attributes
      x-internal: false
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````