Skip to content

OrderAddress ​

Type: schema

Description ​

A billing or shipping address as recorded on the order: a copy made when the order was placed, so later changes to the customer's saved addresses don't alter it. Its fields are null when the order was placed without them (e.g. at a point of sale).

TypeScript Definition ​

typescript
OrderAddress: {{
            /** @description Always `null`: the order's address is a copy, not a saved address. */
            id: null;
            first_name: string | null;
            last_name: string | null;
            business_name: string | null;
            /** @description 10 digit phone number without country code. */
            phone: string | null;
            /** @description Country calling code with a plus sign prefix, e.g. `+91`. */
            country_code: string | null;
            address_line1: string | null;
            address_line2: string | null;
            landmark: string | null;
            pincode: string | null;
            city: string | null;
            state: string | null;
            country: string | null;
            /** @description GSTIN of the business the order was placed for, if given. */
            gstin: string | null;
            /** @description Tax Identification Number specific to the country of operation. */
            tax_identification_number: string | null;
            email: string | null;
            is_email_verified: boolean;
            is_phone_verified: boolean;
        };
        /**
         * OrderCancelledEvent
         * @description Emitted when an order transitions to `cancelled`. A cancel that does not change the status emits nothing.
         */
}

OpenAPI Schema ​

json
{
  "title": "OrderAddress",
  "description": "A billing or shipping address as recorded on the order: a copy made when the order was placed, so later changes to the customer's saved addresses don't alter it. Its fields are `null` when the order was placed without them (e.g. at a point of sale).",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/OrderAddress",
    "description": "API reference for the OrderAddress schema"
  },
  "required": [
    "id",
    "first_name",
    "last_name",
    "business_name",
    "phone",
    "country_code",
    "address_line1",
    "address_line2",
    "landmark",
    "pincode",
    "city",
    "state",
    "country",
    "gstin",
    "tax_identification_number",
    "email",
    "is_email_verified",
    "is_phone_verified"
  ],
  "properties": {
    "id": {
      "description": "Always `null`: the order's address is a copy, not a saved address.",
      "type": "null"
    },
    "first_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "business_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "phone": {
      "description": "10 digit phone number without country code.",
      "type": [
        "string",
        "null"
      ]
    },
    "country_code": {
      "description": "Country calling code with a plus sign prefix, e.g. `+91`.",
      "type": [
        "string",
        "null"
      ]
    },
    "address_line1": {
      "type": [
        "string",
        "null"
      ]
    },
    "address_line2": {
      "type": [
        "string",
        "null"
      ]
    },
    "landmark": {
      "type": [
        "string",
        "null"
      ]
    },
    "pincode": {
      "type": [
        "string",
        "null"
      ]
    },
    "city": {
      "type": [
        "string",
        "null"
      ]
    },
    "state": {
      "type": [
        "string",
        "null"
      ]
    },
    "country": {
      "type": [
        "string",
        "null"
      ]
    },
    "gstin": {
      "description": "GSTIN of the business the order was placed for, if given.",
      "type": [
        "string",
        "null"
      ]
    },
    "tax_identification_number": {
      "description": "Tax Identification Number specific to the country of operation.",
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "type": [
        "string",
        "null"
      ]
    },
    "is_email_verified": {
      "type": "boolean"
    },
    "is_phone_verified": {
      "type": "boolean"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: