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

  • DiscountCode
  • DiscountCodeCollection
  • DiscountCodeDraft
  • DiscountCodeReference
  • DiscountCodeReferenceCollection

Class DiscountCode

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\DiscountCode\DiscountCode
Namespace: Commercetools\Core\Model\DiscountCode
API documentation: https://docs.commercetools.com/http-api-projects-discountCodes.html#discountcode
Located at Core/Model/DiscountCode/DiscountCode.php

Methods summary

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\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\DiscountCode\DiscountCode
# setId( string $id = null )

Parameters

$id

Returns

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

Returns

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

Parameters

$version

Returns

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

Returns

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

Parameters

$createdAt

Returns

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

Returns

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

Parameters

$lastModifiedAt

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public Commercetools\Core\Model\Common\LocalizedString
# getName( )

Returns

Commercetools\Core\Model\Common\LocalizedString
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setName( Commercetools\Core\Model\Common\LocalizedString $name = null )

Parameters

$name

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public Commercetools\Core\Model\Common\LocalizedString
# getDescription( )

Returns

Commercetools\Core\Model\Common\LocalizedString
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setDescription( Commercetools\Core\Model\Common\LocalizedString $description = null )

Parameters

$description

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public string
# getCode( )

Returns

string
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setCode( string $code = null )

Parameters

$code

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public Commercetools\Core\Model\CartDiscount\CartDiscountReferenceCollection
# getCartDiscounts( )

Returns

Commercetools\Core\Model\CartDiscount\CartDiscountReferenceCollection
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setCartDiscounts( Commercetools\Core\Model\CartDiscount\CartDiscountReferenceCollection $cartDiscounts = null )

Parameters

$cartDiscounts

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public mixed
# getCartPredicate( )

Returns

mixed
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setCartPredicate( $cartPredicate = null )

Parameters

$cartPredicate

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public boolean
# getIsActive( )

Returns

boolean
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setIsActive( boolean $isActive = null )

Parameters

$isActive

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public Commercetools\Core\Model\Common\ReferenceCollection
# getReferences( )

Returns

Commercetools\Core\Model\Common\ReferenceCollection
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setReferences( Commercetools\Core\Model\Common\ReferenceCollection $references = null )

Parameters

$references

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public integer
# getMaxApplications( )

Returns

integer
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setMaxApplications( integer $maxApplications = null )

Parameters

$maxApplications

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public integer
# getMaxApplicationsPerCustomer( )

Returns

integer
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setMaxApplicationsPerCustomer( integer $maxApplicationsPerCustomer = null )

Parameters

$maxApplicationsPerCustomer

Returns

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

Returns

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

Parameters

$custom

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public array
# getGroups( )

Returns

array
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setGroups( array $groups = null )

Parameters

$groups

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public Commercetools\Core\Model\Common\DateTimeDecorator
# getValidFrom( )

Returns

Commercetools\Core\Model\Common\DateTimeDecorator
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setValidFrom( DateTime $validFrom = null )

Parameters

$validFrom

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public Commercetools\Core\Model\Common\DateTimeDecorator
# getValidUntil( )

Returns

Commercetools\Core\Model\Common\DateTimeDecorator
public Commercetools\Core\Model\DiscountCode\DiscountCode
# setValidUntil( DateTime $validUntil = null )

Parameters

$validUntil

Returns

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

Returns

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

Parameters

$createdBy

Returns

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

Returns

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

Parameters

$lastModifiedBy

Returns

Commercetools\Core\Model\DiscountCode\DiscountCode
public Commercetools\Core\Model\DiscountCode\DiscountCodeReference
# getReference( )

Returns

Commercetools\Core\Model\DiscountCode\DiscountCodeReference

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