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

  • LineItem
  • LineItemCollection
  • LineItemDraft
  • LineItemDraftCollection
  • MyShoppingListDraft
  • ShoppingList
  • ShoppingListCollection
  • ShoppingListDraft
  • ShoppingListReference
  • TextLineItem
  • TextLineItemCollection
  • TextLineItemDraft
  • TextLineItemDraftCollection

Class ShoppingList

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\ShoppingList\ShoppingList
Namespace: Commercetools\Core\Model\ShoppingList
API documentation: https://docs.commercetools.com/http-api-projects-shoppingLists.html#shoppingList
Located at Core/Model/ShoppingList/ShoppingList.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\ShoppingList\ShoppingList
# setId( string $id = null )

Parameters

$id

Returns

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

Returns

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

Parameters

$key

Returns

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

Returns

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

Parameters

$version

Returns

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

Returns

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

Parameters

$createdAt

Returns

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

Returns

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

Parameters

$lastModifiedAt

Returns

Commercetools\Core\Model\ShoppingList\ShoppingList
public Commercetools\Core\Model\Common\LocalizedString
# getSlug( )

Returns

Commercetools\Core\Model\Common\LocalizedString
public Commercetools\Core\Model\ShoppingList\ShoppingList
# setSlug( Commercetools\Core\Model\Common\LocalizedString $slug = null )

Parameters

$slug

Returns

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

Returns

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

Parameters

$name

Returns

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

Returns

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

Parameters

$description

Returns

Commercetools\Core\Model\ShoppingList\ShoppingList
public Commercetools\Core\Model\Customer\CustomerReference
# getCustomer( )

Returns

Commercetools\Core\Model\Customer\CustomerReference
public Commercetools\Core\Model\ShoppingList\ShoppingList
# setCustomer( Commercetools\Core\Model\Customer\CustomerReference $customer = null )

Parameters

$customer

Returns

Commercetools\Core\Model\ShoppingList\ShoppingList
public Commercetools\Core\Model\ShoppingList\LineItemCollection
# getLineItems( )

Returns

Commercetools\Core\Model\ShoppingList\LineItemCollection
public Commercetools\Core\Model\ShoppingList\ShoppingList
# setLineItems( Commercetools\Core\Model\ShoppingList\LineItemCollection $lineItems = null )

Parameters

$lineItems

Returns

Commercetools\Core\Model\ShoppingList\ShoppingList
public Commercetools\Core\Model\ShoppingList\TextLineItemCollection
# getTextLineItems( )

Returns

Commercetools\Core\Model\ShoppingList\TextLineItemCollection
public Commercetools\Core\Model\ShoppingList\ShoppingList
# setTextLineItems( Commercetools\Core\Model\ShoppingList\TextLineItemCollection $textLineItems = null )

Parameters

$textLineItems

Returns

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

Returns

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

Parameters

$custom

Returns

Commercetools\Core\Model\ShoppingList\ShoppingList
public integer
# getDeleteDaysAfterLastModification( )

Returns

integer
public Commercetools\Core\Model\ShoppingList\ShoppingList
# setDeleteDaysAfterLastModification( integer $deleteDaysAfterLastModification = null )

Parameters

$deleteDaysAfterLastModification

Returns

Commercetools\Core\Model\ShoppingList\ShoppingList
public string
# getAnonymousId( )

Returns

string
public Commercetools\Core\Model\ShoppingList\ShoppingList
# setAnonymousId( string $anonymousId = null )

Parameters

$anonymousId

Returns

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

Returns

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

Parameters

$createdBy

Returns

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

Returns

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

Parameters

$lastModifiedBy

Returns

Commercetools\Core\Model\ShoppingList\ShoppingList
public Commercetools\Core\Model\Store\StoreReference
# getStore( )

Returns

Commercetools\Core\Model\Store\StoreReference
public Commercetools\Core\Model\ShoppingList\ShoppingList
# setStore( Commercetools\Core\Model\Store\StoreReference $store = null )

Parameters

$store

Returns

Commercetools\Core\Model\ShoppingList\ShoppingList
public Commercetools\Core\Model\ShoppingList\ShoppingListReference
# getReference( )

Returns

Commercetools\Core\Model\ShoppingList\ShoppingListReference

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