Composable Commerce PHP SDKPHP SDK
  • Namespace
  • Class
  • Tree

Namespaces

  • Commercetools
    • Commons
      • Helper
    • Core
      • Builder
        • Request
        • Update
      • Cache
      • Client
        • Adapter
        • OAuth
      • Error
      • Helper
        • Annotate
        • State
          • Renderer
        • Subscriber
          • Log
      • Model
        • ApiClient
        • Cart
        • CartDiscount
        • Category
        • Channel
        • Common
        • Customer
        • CustomerGroup
        • CustomField
        • CustomObject
        • DiscountCode
        • Extension
        • Inventory
        • Message
        • Order
        • OrderEdit
        • Payment
        • Product
          • Search
        • ProductDiscount
        • ProductSelection
        • ProductType
        • Project
        • Review
        • ShippingMethod
        • ShoppingList
        • State
        • Store
        • Subscription
        • TaxCategory
        • Type
        • Zone
      • Request
        • ApiClients
        • CartDiscounts
          • Command
        • Carts
          • Command
        • Categories
          • Command
        • Channels
          • Command
        • CustomerGroups
          • Command
        • Customers
          • Command
        • CustomField
          • Command
        • CustomObjects
        • DiscountCodes
          • Command
        • Extensions
          • Command
        • GraphQL
        • InStores
        • Inventory
          • Command
        • Me
          • Command
        • Messages
        • OrderEdits
          • Command
          • StagedOrder
            • Command
        • Orders
          • Command
        • Payments
          • Command
        • ProductDiscounts
          • Command
        • Products
          • Command
        • ProductSelections
          • Command
        • ProductTypes
          • Command
        • Project
          • Command
        • Query
        • Reviews
          • Command
        • ShippingMethods
          • Command
        • ShoppingLists
          • Command
        • States
          • Command
        • Stores
          • Command
        • Subscriptions
          • Command
        • TaxCategories
          • Command
        • Types
          • Command
        • Zones
          • Command
      • Response

Classes

  • Customer
  • CustomerCollection
  • CustomerDraft
  • CustomerReference
  • CustomerSigninResult
  • CustomerToken
  • MyCustomerDraft

Class Customer

Commercetools\Core\Model\Common\AbstractJsonDeserializeObject implements Commercetools\Core\Model\Common\JsonDeserializeInterface, Commercetools\Core\Model\Common\ObjectTreeInterface uses Commercetools\Core\Model\Common\ObjectTreeTrait
Extended by Commercetools\Core\Model\Common\JsonObject implements JsonSerializable uses Commercetools\Core\Model\Common\ContextTrait
Extended by Commercetools\Core\Model\Common\Resource implements Commercetools\Core\Model\Common\ReferenceObjectInterface
Extended by Commercetools\Core\Model\Customer\Customer uses Commercetools\Core\Model\Common\LocaleTrait
Namespace: Commercetools\Core\Model\Customer
API documentation: https://docs.commercetools.com/http-api-projects-customers.html#customer
Located at Core/Model/Customer/Customer.php

Methods summary

public Commercetools\Core\Model\Common\Address|null
# getDefaultShippingAddress( )

Returns

Commercetools\Core\Model\Common\Address|null
public Commercetools\Core\Model\Common\Address|null
# getDefaultBillingAddress( )

Returns

Commercetools\Core\Model\Common\Address|null

Methods inherited from Commercetools\Core\Model\Common\Resource

getReference(), getReferenceIdentifier()

Methods inherited from Commercetools\Core\Model\Common\JsonObject

__construct(), __get(), hasField(), isOptional()

Methods inherited from Commercetools\Core\Model\Common\AbstractJsonDeserializeObject

__sleep(), fromArray(), jsonSerialize(), of(), toArray()

Methods inherited from Commercetools\Core\Model\Common\ObjectTreeInterface

parentSet(), rootGet(), rootSet()

Methods inherited from Commercetools\Core\Model\Common\ContextAwareInterface

getContext(), getContextCallback(), setContext(), setContextIfNull()

Methods used from Commercetools\Core\Model\Common\LocaleTrait

setLocale(), toJson()

Methods used from Commercetools\Core\Model\Common\ContextTrait

getContext(), getContextCallback(), setContext(), setContextIfNull()

Methods used from Commercetools\Core\Model\Common\ObjectTreeTrait

parentSet(), rootGet(), rootSet()

Magic methods summary

public string
# getId( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setId( string $id = null )

Parameters

$id

Returns

Commercetools\Core\Model\Customer\Customer
public integer
# getVersion( )

Returns

integer
public Commercetools\Core\Model\Customer\Customer
# setVersion( integer $version = null )

Parameters

$version

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getCustomerNumber( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setCustomerNumber( string $customerNumber = null )

Parameters

$customerNumber

Returns

Commercetools\Core\Model\Customer\Customer
public Commercetools\Core\Model\Common\DateTimeDecorator
# getCreatedAt( )

Returns

Commercetools\Core\Model\Common\DateTimeDecorator
public Commercetools\Core\Model\Customer\Customer
# setCreatedAt( DateTime $createdAt = null )

Parameters

$createdAt

Returns

Commercetools\Core\Model\Customer\Customer
public Commercetools\Core\Model\Common\DateTimeDecorator
# getLastModifiedAt( )

Returns

Commercetools\Core\Model\Common\DateTimeDecorator
public Commercetools\Core\Model\Customer\Customer
# setLastModifiedAt( DateTime $lastModifiedAt = null )

Parameters

$lastModifiedAt

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getEmail( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setEmail( string $email = null )

Parameters

$email

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getFirstName( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setFirstName( string $firstName = null )

Parameters

$firstName

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getLastName( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setLastName( string $lastName = null )

Parameters

$lastName

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getPassword( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setPassword( string $password = null )

Parameters

$password

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getMiddleName( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setMiddleName( string $middleName = null )

Parameters

$middleName

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getTitle( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setTitle( string $title = null )

Parameters

$title

Returns

Commercetools\Core\Model\Customer\Customer
public Commercetools\Core\Model\Common\DateDecorator
# getDateOfBirth( )

Returns

Commercetools\Core\Model\Common\DateDecorator
public Commercetools\Core\Model\Customer\Customer
# setDateOfBirth( DateTime $dateOfBirth = null )

Parameters

$dateOfBirth

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getCompanyName( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setCompanyName( string $companyName = null )

Parameters

$companyName

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getVatId( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setVatId( string $vatId = null )

Parameters

$vatId

Returns

Commercetools\Core\Model\Customer\Customer
public Commercetools\Core\Model\Common\AddressCollection
# getAddresses( )

Returns

Commercetools\Core\Model\Common\AddressCollection
public Commercetools\Core\Model\Customer\Customer
# setAddresses( Commercetools\Core\Model\Common\AddressCollection $addresses = null )

Parameters

$addresses

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getDefaultShippingAddressId( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setDefaultShippingAddressId( string $defaultShippingAddressId = null )

Parameters

$defaultShippingAddressId

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getDefaultBillingAddressId( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setDefaultBillingAddressId( string $defaultBillingAddressId = null )

Parameters

$defaultBillingAddressId

Returns

Commercetools\Core\Model\Customer\Customer
public boolean
# getIsEmailVerified( )

Returns

boolean
public Commercetools\Core\Model\Customer\Customer
# setIsEmailVerified( boolean $isEmailVerified = null )

Parameters

$isEmailVerified

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getExternalId( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setExternalId( string $externalId = null )

Parameters

$externalId

Returns

Commercetools\Core\Model\Customer\Customer
public Commercetools\Core\Model\CustomerGroup\CustomerGroupReference
# getCustomerGroup( )

Returns

Commercetools\Core\Model\CustomerGroup\CustomerGroupReference
public Commercetools\Core\Model\Customer\Customer
# setCustomerGroup( Commercetools\Core\Model\CustomerGroup\CustomerGroupReference $customerGroup = null )

Parameters

$customerGroup

Returns

Commercetools\Core\Model\Customer\Customer
public Commercetools\Core\Model\CustomField\CustomFieldObject
# getCustom( )

Returns

Commercetools\Core\Model\CustomField\CustomFieldObject
public Commercetools\Core\Model\Customer\Customer
# setCustom( Commercetools\Core\Model\CustomField\CustomFieldObject $custom = null )

Parameters

$custom

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getLocale( )

Returns

string
public array
# getShippingAddressIds( )

Returns

array
public Commercetools\Core\Model\Customer\Customer
# setShippingAddressIds( array $shippingAddressIds = null )

Parameters

$shippingAddressIds

Returns

Commercetools\Core\Model\Customer\Customer
public array
# getBillingAddressIds( )

Returns

array
public Commercetools\Core\Model\Customer\Customer
# setBillingAddressIds( array $billingAddressIds = null )

Parameters

$billingAddressIds

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getSalutation( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setSalutation( string $salutation = null )

Parameters

$salutation

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getKey( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setKey( string $key = null )

Parameters

$key

Returns

Commercetools\Core\Model\Customer\Customer
public Commercetools\Core\Model\Common\CreatedBy
# getCreatedBy( )

Returns

Commercetools\Core\Model\Common\CreatedBy
public Commercetools\Core\Model\Customer\Customer
# setCreatedBy( Commercetools\Core\Model\Common\CreatedBy $createdBy = null )

Parameters

$createdBy

Returns

Commercetools\Core\Model\Customer\Customer
public Commercetools\Core\Model\Common\LastModifiedBy
# getLastModifiedBy( )

Returns

Commercetools\Core\Model\Common\LastModifiedBy
public Commercetools\Core\Model\Customer\Customer
# setLastModifiedBy( Commercetools\Core\Model\Common\LastModifiedBy $lastModifiedBy = null )

Parameters

$lastModifiedBy

Returns

Commercetools\Core\Model\Customer\Customer
public Commercetools\Core\Model\Store\StoreReferenceCollection
# getStores( )

Returns

Commercetools\Core\Model\Store\StoreReferenceCollection
public Commercetools\Core\Model\Customer\Customer
# setStores( Commercetools\Core\Model\Store\StoreReferenceCollection $stores = null )

Parameters

$stores

Returns

Commercetools\Core\Model\Customer\Customer
public string
# getAuthenticationMode( )

Returns

string
public Commercetools\Core\Model\Customer\Customer
# setAuthenticationMode( string $authenticationMode = null )

Parameters

$authenticationMode

Returns

Commercetools\Core\Model\Customer\Customer
public Commercetools\Core\Model\Customer\CustomerReference
# getReference( )

Returns

Commercetools\Core\Model\Customer\CustomerReference

Overrides

Commercetools\Core\Model\Common\Resource::getReference

Constants summary

Constants inherited from Commercetools\Core\Model\Common\JsonObject

DECORATOR, ELEMENT_TYPE, INITIALIZED, OPTIONAL, TYPE

Constants inherited from Commercetools\Core\Model\Common\AbstractJsonDeserializeObject

JSON_DESERIALIZE_INTERFACE, TYPEABLE_INTERFACE

PHP SDK API documentation generated by ApiGen