Log in
Interface

OrderAddressInterface

Magento\Sales\Api\Data\OrderAddressInterface

What it does

This interface defines the structure for order address data in Magento 2's Sales module.

Developers use this when working with billing or shipping addresses associated with orders, whether retrieving address information for display, API responses, or programmatically setting address data during order creation or updates.

It provides getter and setter methods for all standard address fields including name, street, city, region, postal code, country, VAT information, and supports extension attributes for custom fields.

Public Methods

  • getAddressType()
  • getCity()
  • getCompany()
  • getCountryId()
  • getCustomerAddressId()
  • getCustomerId()
  • getEmail()
  • getEntityId()
  • setEntityId()
  • getFax()
  • getFirstname()
  • getLastname()
  • getMiddlename()
  • getParentId()
  • getPostcode()
  • getPrefix()
  • getRegion()
  • getRegionCode()
  • getRegionId()
  • getStreet()
  • getSuffix()
  • getTelephone()
  • getVatId()
  • getVatIsValid()
  • getVatRequestDate()
  • getVatRequestId()
  • getVatRequestSuccess()
  • setParentId()
  • setCustomerAddressId()
  • setRegionId()
  • setCustomerId()
  • setFax()
  • setRegion()
  • setPostcode()
  • setLastname()
  • setStreet()
  • setCity()
  • setEmail()
  • setTelephone()
  • setCountryId()
  • setFirstname()
  • setAddressType()
  • setPrefix()
  • setMiddlename()
  • setSuffix()
  • setCompany()
  • setVatId()
  • setVatIsValid()
  • setVatRequestId()
  • setRegionCode()
  • setVatRequestDate()
  • setVatRequestSuccess()
  • getExtensionAttributes()
  • setExtensionAttributes()