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

# Create or search a live address mapping.

> Create or search a live address mapping.

**Authentication:** Customer auth header is shown in the source comment.

**Feature area:** Customer address

**Implementation source:** `src/api/store/controllers/CustomerAddressController.ts`

**Request example provenance:** Illustrative response; handler returns an address provider-dependent structure.

**Response example provenance:** Illustrative response; handler returns an address provider-dependent structure.

> **Example status: Illustrative.** The example is included to demonstrate request/response shape in the reference UI; verify the owning controller and request DTO before using it as a contract.



## OpenAPI

````yaml /StoreAPI.json post /api/customer-address/live/
openapi: 3.0.3
info:
  title: SpurtCommerce Store API
  version: 6.0.0
  description: >-
    Store API reference generated from the public SpurtCommerce repository
    (master, package version 6.0.0). Route inventory, controller annotations,
    request examples and response examples were used where available. Examples
    that are not explicitly defined by source annotations are marked
    illustrative in the operation description. This specification excludes Admin
    APIs.
  license:
    name: MIT
    url: https://github.com/spurtcommerce/spurtcommerce/blob/master/LICENSE
servers:
  - url: https://api.example.com
    description: Replace with your SpurtCommerce API host. Paths include the /api prefix.
security: []
tags:
  - name: Store
    description: Store API endpoint reference, organized by functional topic.
  - name: Cart
    description: >-
      Retrieve, create, update, and clear the authenticated customer shopping
      cart.
    x-parent: Store
    x-displayName: Cart
  - name: Customer address
    description: >-
      Create, retrieve, and manage customer addresses and live-address settings
      used during checkout.
    x-parent: Store
    x-displayName: Customer address
  - name: Customer profile
    description: >-
      Retrieve and update the signed-in customer profile and read customer
      permission modules and assignments.
    x-parent: Store
    x-displayName: Customer profile
  - name: Authentication
    description: >-
      Register customers, send and verify OTPs, sign in, sign out, and
      authenticate through supported OAuth providers.
    x-parent: Store
    x-displayName: Authentication
  - name: Wishlist
    description: >-
      Add products to the customer wishlist, list saved items, and remove
      wishlist entries.
    x-parent: Store
    x-displayName: Wishlist
  - name: Product discovery
    description: >-
      Discover products and categories, retrieve product details, compare
      products, and inspect filters, attributes, and variants.
    x-parent: Store
    x-displayName: Product discovery
  - name: Orders
    description: >-
      Retrieve order details and payment status, request cancellations, track
      shipments, download invoices, and retry payments.
    x-parent: Store
    x-displayName: Orders
  - name: Store content
    description: >-
      Retrieve storefront settings, categories, languages, zones, payment
      methods, CMS pages, banners, widgets, and contact information.
    x-parent: Store
    x-displayName: Store content
  - name: Payments
    description: >-
      Start supported Store payment flows for existing orders through PayPal,
      Razorpay, and Stripe.
    x-parent: Store
    x-displayName: Payments
  - name: Ratings and reviews
    description: >-
      Retrieve product rating counts, rating distributions, and customer reviews
      for product SKUs.
    x-parent: Store
    x-displayName: Ratings and reviews
  - name: Products
    x-parent: Product discovery
    description: Browse product listings and retrieve product details.
  - name: Categories
    x-parent: Product discovery
    description: Browse storefront product categories and category filters.
  - name: Product comparison
    x-parent: Product discovery
    description: Compare products and retrieve related product suggestions.
  - name: Attributes and variants
    x-parent: Product discovery
    description: Retrieve product attributes and variant options.
  - name: Product ratings and reviews
    x-parent: Product discovery
    description: Retrieve product ratings, statistics and customer reviews.
  - name: Customer login and sessions
    x-parent: Authentication
    description: Register, authenticate and sign out customer accounts.
  - name: OTP and verification
    x-parent: Authentication
    description: Send and verify one-time passwords for customer authentication.
  - name: OAuth authentication
    x-parent: Authentication
    description: Authenticate customers through supported OAuth providers.
  - name: Customer permissions
    x-parent: Customer profile
    description: Retrieve customer permission modules and assignments.
  - name: Address book
    x-parent: Customer address
    description: Manage customer delivery and billing addresses.
  - name: Cart items
    x-parent: Cart
    description: Retrieve, create and remove shopping cart items.
  - name: Order details and tracking
    x-parent: Orders
    description: Retrieve order details, tracking and payment status.
  - name: Order cancellation
    x-parent: Orders
    description: Retrieve cancellation reasons and submit cancellation requests.
  - name: Order payments
    x-parent: Orders
    description: Retry order payments and retrieve payment status.
  - name: Payment gateways
    x-parent: Payments
    description: Start Store payment flows for supported payment gateways.
  - name: Store configuration
    x-parent: Store content
    description: Retrieve storefront settings, payment methods and configuration.
  - name: Navigation and widgets
    x-parent: Store content
    description: Retrieve storefront banners, widgets and navigation data.
  - name: Localization
    x-parent: Store content
    description: Retrieve available languages, zones and localization options.
  - name: Contact and store information
    x-parent: Store content
    description: Retrieve store contact information and public store metadata.
  - name: Store pages
    x-parent: Store content
    description: Retrieve published storefront content pages.
paths:
  /api/customer-address/live/:
    post:
      tags:
        - Address book
      summary: Create or search a live address mapping.
      description: >-
        Create or search a live address mapping.


        **Authentication:** Customer auth header is shown in the source comment.


        **Feature area:** Customer address


        **Implementation source:**
        `src/api/store/controllers/CustomerAddressController.ts`


        **Request example provenance:** Illustrative response; handler returns
        an address provider-dependent structure.


        **Response example provenance:** Illustrative response; handler returns
        an address provider-dependent structure.


        > **Example status: Illustrative.** The example is included to
        demonstrate request/response shape in the reference UI; verify the
        owning controller and request DTO before using it as a contract.
      operationId: postApiCustomerAddressLive
      requestBody:
        required: false
        description: >-
          Sample request body. Illustrative response; handler returns an address
          provider-dependent structure. Treat this as an illustrative example,
          not a complete DTO contract.
        content:
          application/json:
            schema:
              type: object
              properties:
                address1:
                  type: string
                address2:
                  type: string
                city:
                  type: string
                state:
                  type: string
                postcode:
                  type: string
                countryId:
                  type: integer
              additionalProperties: true
            examples:
              sample:
                summary: Sample request
                value:
                  address1: 12 Market Road
                  address2: Suite 4
                  city: Chennai
                  state: Tamil Nadu
                  postcode: '600001'
                  countryId: 99
      responses:
        '200':
          description: >-
            Successful response. Illustrative response; handler returns an
            address provider-dependent structure. Example is illustrative and
            does not guarantee a stable response contract.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties: {}
                    additionalProperties: true
                additionalProperties: true
              examples:
                success:
                  summary: Sample success response
                  value:
                    status: 1
                    message: Live Address saved successfully.
                    data: {}
      externalDocs:
        description: Open implementation source in GitHub
        url: >-
          https://github.com/spurtcommerce/spurtcommerce/blob/master/src/api/store/controllers/CustomerAddressController.ts
      x-codeSamples:
        - lang: HTTP
          label: HTTP
          source: |-
            POST /api/customer-address/live/ HTTP/1.1
            Host: <API_HOST>
            Accept: application/json
            Content-Type: application/json

            {
              "address1": "12 Market Road",
              "address2": "Suite 4",
              "city": "Chennai",
              "state": "Tamil Nadu",
              "postcode": "600001",
              "countryId": 99
            }
        - lang: bash
          label: cURL
          source: |-
            curl --request POST \
              'https://<API_HOST>/api/customer-address/live/' \
              --header 'Accept: application/json' \
              --header 'Content-Type: application/json' \
              --data-raw '{
              "address1": "12 Market Road",
              "address2": "Suite 4",
              "city": "Chennai",
              "state": "Tamil Nadu",
              "postcode": "600001",
              "countryId": 99
            }'
        - lang: JavaScript
          label: JavaScript (fetch)
          source: >-
            const API_BASE_URL = 'https://<API_HOST>';

            const url = new URL("/api/customer-address/live/", API_BASE_URL);

            const headers = {
              "Accept": "application/json",
              "Content-Type": "application/json"
            };

            const body = {
              "address1": "12 Market Road",
              "address2": "Suite 4",
              "city": "Chennai",
              "state": "Tamil Nadu",
              "postcode": "600001",
              "countryId": 99
            };

            const response = await fetch(url, { method: "POST", headers, body:
            JSON.stringify(body) });

            const result = await response.json();

            console.log(response.status, result);
        - lang: JavaScript
          label: Node.js (Axios)
          source: >-
            import axios from 'axios';

            const API_BASE_URL = 'https://<API_HOST>';

            const url = `${API_BASE_URL}/api/customer-address/live/`;

            const API_BASE_URL = 'https://<API_HOST>';

            const url = `${API_BASE_URL}/api/customer-address/live/`;

            const headers = {
              "Accept": "application/json",
              "Content-Type": "application/json"
            };

            const data = {
              "address1": "12 Market Road",
              "address2": "Suite 4",
              "city": "Chennai",
              "state": "Tamil Nadu",
              "postcode": "600001",
              "countryId": 99
            };

            const response = await axios.request({ method: "POST", url, headers,
            data });

            console.log(response.status, response.data);
        - lang: Python
          label: Python (requests)
          source: >-
            import requests

            url = 'https://<API_HOST>/api/customer-address/live/'

            headers = {'Accept': 'application/json', 'Content-Type':
            'application/json'}

            payload = {'address1': '12 Market Road', 'address2': 'Suite 4',
            'city': 'Chennai', 'state': 'Tamil Nadu', 'postcode': '600001',
            'countryId': 99}

            response = requests.request('POST', url, headers=headers,
            params=None, json=payload)

            print(response.status_code)

            print(response.json())

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.