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

  • ActionBuilder
  • CartDiscountsActionBuilder
  • CartsActionBuilder
  • CategoriesActionBuilder
  • ChannelsActionBuilder
  • CustomerGroupsActionBuilder
  • CustomersActionBuilder
  • CustomFieldActionBuilder
  • DiscountCodesActionBuilder
  • ExtensionsActionBuilder
  • InventoryActionBuilder
  • MeActionBuilder
  • OrderEditsActionBuilder
  • OrdersActionBuilder
  • PaymentsActionBuilder
  • ProductDiscountsActionBuilder
  • ProductsActionBuilder
  • ProductSelectionsActionBuilder
  • ProductTypesActionBuilder
  • ProjectActionBuilder
  • ReviewsActionBuilder
  • ShippingMethodsActionBuilder
  • ShoppingListsActionBuilder
  • StagedOrderActionBuilder
  • StatesActionBuilder
  • StoresActionBuilder
  • SubscriptionsActionBuilder
  • TaxCategoriesActionBuilder
  • TypesActionBuilder
  • ZonesActionBuilder

Class OrdersActionBuilder

Namespace: Commercetools\Core\Builder\Update
Located at Core/Builder/Update/OrdersActionBuilder.php

Methods summary

public Commercetools\Core\Builder\Update\OrdersActionBuilder
# addDelivery( Commercetools\Core\Request\Orders\Command\OrderAddDeliveryAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#add-delivery
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# addItemShippingAddress( Commercetools\Core\Request\Orders\Command\OrderAddItemShippingAddressAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#add-itemshippingaddress
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# addParcelToDelivery( Commercetools\Core\Request\Orders\Command\OrderAddParcelToDeliveryAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#add-parcel
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# addPayment( Commercetools\Core\Request\Orders\Command\OrderAddPaymentAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#add-payment
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# addReturnInfo( Commercetools\Core\Request\Orders\Command\OrderAddReturnInfoAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#addreturninfo
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# changeOrderState( Commercetools\Core\Request\Orders\Command\OrderChangeOrderStateAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#change-orderstate
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# changePaymentState( Commercetools\Core\Request\Orders\Command\OrderChangePaymentStateAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#change-paymentstate
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# changeShipmentState( Commercetools\Core\Request\Orders\Command\OrderChangeShipmentStateAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#change-shipmentstate
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# importCustomLineItemState( Commercetools\Core\Request\Orders\Command\OrderImportCustomLineItemStateAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#import-state-for-customlineitems
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# importLineItemState( Commercetools\Core\Request\Orders\Command\OrderImportLineItemStateAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#import-state-for-lineitems
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# removeDelivery( Commercetools\Core\Request\Orders\Command\OrderRemoveDeliveryAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#remove-delivery
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# removeItemShippingAddress( Commercetools\Core\Request\Orders\Command\OrderRemoveItemShippingAddressAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#remove-itemshippingaddress
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# removeParcelFromDelivery( Commercetools\Core\Request\Orders\Command\OrderRemoveParcelFromDeliveryAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#remove-parcel-from-delivery
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# removePayment( Commercetools\Core\Request\Orders\Command\OrderRemovePaymentAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#remove-payment
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setBillingAddress( Commercetools\Core\Request\Orders\Command\OrderSetBillingAddress|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-billing-address
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setBillingAddressCustomField( Commercetools\Core\Request\Orders\Command\OrderSetBillingAddressCustomFieldAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setBillingAddressCustomType( Commercetools\Core\Request\Orders\Command\OrderSetBillingAddressCustomTypeAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setCustomField( Commercetools\Core\Request\Orders\Command\OrderSetCustomFieldAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setCustomLineItemCustomField( Commercetools\Core\Request\Orders\Command\OrderSetCustomLineItemCustomFieldAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setCustomLineItemCustomType( Commercetools\Core\Request\Orders\Command\OrderSetCustomLineItemCustomTypeAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setCustomLineItemShippingDetails( Commercetools\Core\Request\Orders\Command\OrderSetCustomLineItemShippingDetailsAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-customlineitemshippingdetails
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setCustomType( Commercetools\Core\Request\Orders\Command\OrderSetCustomTypeAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setCustomerEmail( Commercetools\Core\Request\Orders\Command\OrderSetCustomerEmail|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-customer-email
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setCustomerId( Commercetools\Core\Request\Orders\Command\OrderSetCustomerIdAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-customer-id
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setDeliveryAddress( Commercetools\Core\Request\Orders\Command\OrderSetDeliveryAddressAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-delivery-address
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setDeliveryAddressCustomField( Commercetools\Core\Request\Orders\Command\OrderSetDeliveryAddressCustomFieldAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setDeliveryAddressCustomType( Commercetools\Core\Request\Orders\Command\OrderSetDeliveryAddressCustomTypeAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setDeliveryCustomField( Commercetools\Core\Request\Orders\Command\OrderSetDeliveryCustomFieldAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setDeliveryCustomType( Commercetools\Core\Request\Orders\Command\OrderSetDeliveryCustomTypeAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setDeliveryItems( Commercetools\Core\Request\Orders\Command\OrderSetDeliveryItemsAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-delivery-items
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setItemShippingAddressCustomField( Commercetools\Core\Request\Orders\Command\OrderSetItemShippingAddressCustomFieldAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setItemShippingAddressCustomType( Commercetools\Core\Request\Orders\Command\OrderSetItemShippingAddressCustomTypeAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setLineItemCustomField( Commercetools\Core\Request\Orders\Command\OrderSetLineItemCustomFieldAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setLineItemCustomType( Commercetools\Core\Request\Orders\Command\OrderSetLineItemCustomTypeAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setLineItemShippingDetails( Commercetools\Core\Request\Orders\Command\OrderSetLineItemShippingDetailsAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-lineitemshippingdetails
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setLocale( Commercetools\Core\Request\Orders\Command\OrderSetLocaleAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-locale
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setOrderNumber( Commercetools\Core\Request\Orders\Command\OrderSetOrderNumberAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-order-number
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setParcelCustomField( Commercetools\Core\Request\Orders\Command\OrderSetParcelCustomFieldAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setParcelCustomType( Commercetools\Core\Request\Orders\Command\OrderSetParcelCustomTypeAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setParcelItems( Commercetools\Core\Request\Orders\Command\OrderSetParcelItemsAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-parcel-items
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setParcelMeasurements( Commercetools\Core\Request\Orders\Command\OrderSetParcelMeasurementsAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-parcel-measurements
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setParcelTrackingData( Commercetools\Core\Request\Orders\Command\OrderSetParcelTrackingDataAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-parcel-tracking-data
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setReturnInfo( Commercetools\Core\Request\Orders\Command\OrderSetReturnInfoAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-delivery-items
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setReturnItemCustomField( Commercetools\Core\Request\Orders\Command\OrderSetReturnItemCustomFieldAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setReturnItemCustomType( Commercetools\Core\Request\Orders\Command\OrderSetReturnItemCustomTypeAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setReturnPaymentState( Commercetools\Core\Request\Orders\Command\OrderSetReturnPaymentStateAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-returnpaymentstate
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setReturnShipmentState( Commercetools\Core\Request\Orders\Command\OrderSetReturnShipmentStateAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-returnshipmentstate
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setShippingAddress( Commercetools\Core\Request\Orders\Command\OrderSetShippingAddress|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-shipping-address
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setShippingAddressCustomField( Commercetools\Core\Request\Orders\Command\OrderSetShippingAddressCustomFieldAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setShippingAddressCustomType( Commercetools\Core\Request\Orders\Command\OrderSetShippingAddressCustomTypeAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setStore( Commercetools\Core\Request\Orders\Command\OrderSetStoreAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#set-store-beta
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# transitionCustomLineItemState( Commercetools\Core\Request\Orders\Command\OrderTransitionCustomLineItemStateAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#change-the-state-of-customlineitem-according-to-allowed-transitions
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# transitionLineItemState( Commercetools\Core\Request\Orders\Command\OrderTransitionLineItemStateAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#change-the-state-of-lineitem-according-to-allowed-transitions
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# transitionState( Commercetools\Core\Request\Orders\Command\OrderTransitionStateAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#transition-state
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# updateItemShippingAddress( Commercetools\Core\Request\Orders\Command\OrderUpdateItemShippingAddressAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#update-itemshippingaddress
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# updateSyncInfo( Commercetools\Core\Request\Orders\Command\OrderUpdateSyncInfoAction|callable $action = null )

Parameters

$action

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this

Link

https://docs.commercetools.com/http-api-projects-orders.html#update-syncinfo
public static Commercetools\Core\Builder\Update\OrdersActionBuilder
# of( )

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
public $this;
# addAction( Commercetools\Core\Request\AbstractAction $action )

Parameters

$action

Returns

$this;
$this;
public array
# getActions( )

Returns

array
public Commercetools\Core\Builder\Update\OrdersActionBuilder
# setActions( array $actions )

Parameters

$actions

Returns

Commercetools\Core\Builder\Update\OrdersActionBuilder
$this
PHP SDK API documentation generated by ApiGen