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

  • Delivery
  • DeliveryCollection
  • DeliveryItem
  • DeliveryItemCollection
  • ImportOrder
  • ItemState
  • ItemStateCollection
  • LineItemImportDraft
  • LineItemImportDraftCollection
  • Order
  • OrderCollection
  • OrderReference
  • OrderState
  • Parcel
  • ParcelCollection
  • ParcelMeasurements
  • PaymentState
  • ProductVariantImportDraft
  • ReturnInfo
  • ReturnInfoCollection
  • ReturnItem
  • ReturnItemCollection
  • ReturnPaymentState
  • ReturnShipmentState
  • ShipmentState
  • ShippingInfoImportDraft
  • SyncInfo
  • SyncInfoCollection
  • TrackingData

Class Order

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\Order\Order uses Commercetools\Core\Model\Common\LocaleTrait

Direct known subclasses

Commercetools\Core\Model\OrderEdit\StagedOrder

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

Parameters

$id

Returns

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

Returns

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

Parameters

$version

Returns

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

Returns

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

Parameters

$createdAt

Returns

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

Returns

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

Parameters

$lastModifiedAt

Returns

Commercetools\Core\Model\Order\Order
public string
# getOrderNumber( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setOrderNumber( string $orderNumber = null )

Parameters

$orderNumber

Returns

Commercetools\Core\Model\Order\Order
public string
# getCustomerId( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setCustomerId( string $customerId = null )

Parameters

$customerId

Returns

Commercetools\Core\Model\Order\Order
public string
# getCustomerEmail( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setCustomerEmail( string $customerEmail = null )

Parameters

$customerEmail

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Cart\LineItemCollection
# getLineItems( )

Returns

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

Parameters

$lineItems

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Cart\CustomLineItemCollection
# getCustomLineItems( )

Returns

Commercetools\Core\Model\Cart\CustomLineItemCollection
public Commercetools\Core\Model\Order\Order
# setCustomLineItems( Commercetools\Core\Model\Cart\CustomLineItemCollection $customLineItems = null )

Parameters

$customLineItems

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Common\Money
# getTotalPrice( )

Returns

Commercetools\Core\Model\Common\Money
public Commercetools\Core\Model\Order\Order
# setTotalPrice( Commercetools\Core\Model\Common\Money $totalPrice = null )

Parameters

$totalPrice

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Common\TaxedPrice
# getTaxedPrice( )

Returns

Commercetools\Core\Model\Common\TaxedPrice
public Commercetools\Core\Model\Order\Order
# setTaxedPrice( Commercetools\Core\Model\Common\TaxedPrice $taxedPrice = null )

Parameters

$taxedPrice

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Common\Address
# getShippingAddress( )

Returns

Commercetools\Core\Model\Common\Address
public Commercetools\Core\Model\Order\Order
# setShippingAddress( Commercetools\Core\Model\Common\Address $shippingAddress = null )

Parameters

$shippingAddress

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Common\Address
# getBillingAddress( )

Returns

Commercetools\Core\Model\Common\Address
public Commercetools\Core\Model\Order\Order
# setBillingAddress( Commercetools\Core\Model\Common\Address $billingAddress = null )

Parameters

$billingAddress

Returns

Commercetools\Core\Model\Order\Order
public string
# getInventoryMode( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setInventoryMode( string $inventoryMode = null )

Parameters

$inventoryMode

Returns

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

Returns

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

Parameters

$customerGroup

Returns

Commercetools\Core\Model\Order\Order
public string
# getCountry( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setCountry( string $country = null )

Parameters

$country

Returns

Commercetools\Core\Model\Order\Order
public string
# getOrderState( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setOrderState( string $orderState = null )

Parameters

$orderState

Returns

Commercetools\Core\Model\Order\Order
public string
# getShipmentState( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setShipmentState( string $shipmentState = null )

Parameters

$shipmentState

Returns

Commercetools\Core\Model\Order\Order
public string
# getPaymentState( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setPaymentState( string $paymentState = null )

Parameters

$paymentState

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Cart\ShippingInfo
# getShippingInfo( )

Returns

Commercetools\Core\Model\Cart\ShippingInfo
public Commercetools\Core\Model\Order\Order
# setShippingInfo( Commercetools\Core\Model\Cart\ShippingInfo $shippingInfo = null )

Parameters

$shippingInfo

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Order\SyncInfoCollection
# getSyncInfo( )

Returns

Commercetools\Core\Model\Order\SyncInfoCollection
public Commercetools\Core\Model\Order\Order
# setSyncInfo( Commercetools\Core\Model\Order\SyncInfoCollection $syncInfo = null )

Parameters

$syncInfo

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Order\ReturnInfoCollection
# getReturnInfo( )

Returns

Commercetools\Core\Model\Order\ReturnInfoCollection
public Commercetools\Core\Model\Order\Order
# setReturnInfo( Commercetools\Core\Model\Order\ReturnInfoCollection $returnInfo = null )

Parameters

$returnInfo

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Cart\DiscountCodeInfoCollection
# getDiscountCodes( )

Returns

Commercetools\Core\Model\Cart\DiscountCodeInfoCollection
public Commercetools\Core\Model\Order\Order
# setDiscountCodes( Commercetools\Core\Model\Cart\DiscountCodeInfoCollection $discountCodes = null )

Parameters

$discountCodes

Returns

Commercetools\Core\Model\Order\Order
public integer
# getLastMessageSequenceNumber( )

Returns

integer
public Commercetools\Core\Model\Order\Order
# setLastMessageSequenceNumber( integer $lastMessageSequenceNumber = null )

Parameters

$lastMessageSequenceNumber

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Cart\CartReference
# getCart( )

Returns

Commercetools\Core\Model\Cart\CartReference
public Commercetools\Core\Model\Order\Order
# setCart( Commercetools\Core\Model\Cart\CartReference $cart = null )

Parameters

$cart

Returns

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

Returns

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

Parameters

$custom

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\State\StateReference
# getState( )

Returns

Commercetools\Core\Model\State\StateReference
public Commercetools\Core\Model\Order\Order
# setState( Commercetools\Core\Model\State\StateReference $state = null )

Parameters

$state

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Payment\PaymentInfo
# getPaymentInfo( )

Returns

Commercetools\Core\Model\Payment\PaymentInfo
public Commercetools\Core\Model\Order\Order
# setPaymentInfo( Commercetools\Core\Model\Payment\PaymentInfo $paymentInfo = null )

Parameters

$paymentInfo

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Common\DateTimeDecorator
# getCompletedAt( )

Returns

Commercetools\Core\Model\Common\DateTimeDecorator
public Commercetools\Core\Model\Order\Order
# setCompletedAt( DateTime $completedAt = null )

Parameters

$completedAt

Returns

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

Returns

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

Parameters

$anonymousId

Returns

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

Returns

string
public string
# getTaxRoundingMode( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setTaxRoundingMode( string $taxRoundingMode = null )

Parameters

$taxRoundingMode

Returns

Commercetools\Core\Model\Order\Order
public string
# getOrigin( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setOrigin( string $origin = null )

Parameters

$origin

Returns

Commercetools\Core\Model\Order\Order
public string
# getTaxCalculationMode( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setTaxCalculationMode( string $taxCalculationMode = null )

Parameters

$taxCalculationMode

Returns

Commercetools\Core\Model\Order\Order
public string
# getTaxMode( )

Returns

string
public Commercetools\Core\Model\Order\Order
# setTaxMode( string $taxMode = null )

Parameters

$taxMode

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Cart\ShippingRateInput
# getShippingRateInput( )

Returns

Commercetools\Core\Model\Cart\ShippingRateInput
public Commercetools\Core\Model\Order\Order
# setShippingRateInput( Commercetools\Core\Model\Cart\ShippingRateInput $shippingRateInput = null )

Parameters

$shippingRateInput

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Common\AddressCollection
# getItemShippingAddresses( )

Returns

Commercetools\Core\Model\Common\AddressCollection
public Commercetools\Core\Model\Order\Order
# setItemShippingAddresses( Commercetools\Core\Model\Common\AddressCollection $itemShippingAddresses = null )

Parameters

$itemShippingAddresses

Returns

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

Returns

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

Parameters

$store

Returns

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

Returns

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

Parameters

$createdBy

Returns

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

Returns

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

Parameters

$lastModifiedBy

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\CartDiscount\CartDiscountReferenceCollection
# getRefusedGifts( )

Returns

Commercetools\Core\Model\CartDiscount\CartDiscountReferenceCollection
public Commercetools\Core\Model\Order\Order
# setRefusedGifts( Commercetools\Core\Model\CartDiscount\CartDiscountReferenceCollection $refusedGifts = null )

Parameters

$refusedGifts

Returns

Commercetools\Core\Model\Order\Order
public Commercetools\Core\Model\Order\OrderReference
# getReference( )

Returns

Commercetools\Core\Model\Order\OrderReference

Overrides

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

Constants summary

string TAX_MODE_PLATFORM
# 'Platform'
string TAX_MODE_EXTERNAL
# 'External'
string TAX_MODE_DISABLED
# 'Disabled'
string TAX_ROUNDING_MODE_HALF_EVEN
# 'HalfEven'
string TAX_ROUNDING_MODE_HALF_UP
# 'HalfUp'
string TAX_ROUNDING_MODE_HALF_DOWN
# 'HalfDown'

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