Skip to content

Order Actor Commands

addActivityLog

Adds an activity log to an Order

addDeliveryTag

Adds a tag to a Delivery

addTag

Adds a tag to an Order

cancelInvoice

Cancels an Invoice

completeDelivery

Marks a delivery as completed.

createComputedOrderDiscount

Adds a new computed Order Discount to an Order based on a component

createComputedOrderDiscountBySource

Adds a new computed Order Discount to an Order using an embedded source code for the logic

createDelivery

Adds a new Delivery to an Order

createOrderLine

Creates a new Order Row

createReturn

Creates a Return for a specific Order Row

createStaticOrderDiscount

Creates a static discount on an Order. An order discount value is distributed across all order lines and shipping fees proportionally to their value.

createStaticOrderLineDiscount

Creates a static discount on an order line

createStaticShippingDiscount

Creates a static discount on a shipping fee

deleteDiscount

Deletes an existing Discount from an Order

deleteOrderLine

Deletes an existing Order Row

generateOrderNumberByPrefix

Generates an order number for an order based on the given prefix

invoiceDeliveries

Invoice one or more Deliveries from an Order.

invoiceOrder

Invoices all deliveries on the Order regardless of status. If you want to invoice only certain deliveries, use invoiceDeliveries command.

linkPayment

Associates a Payment with an Order

releaseDelivery

Releases a delivery for fulfillment processing.

removeDeliveryTag

Removes a tag from a Delivery

removeTag

Removes a tag from an Order

setComputedOrderDiscountParameters

Sets a computed order discount's parameters

setDeliveryAddress

Sets the Address of a Delivery

setDeliveryInventory

Sets the inventory and inventory date of a Delivery. Stock reservations will be updated if there are any.

setDiscountDynamicFields

Sets dynamic fields of a discount. Non specified fields will be left unchanged. Set value to null to remove field.

setInvoiceAddress

Sets the invoice address of an Order which will be used for new invoices

setLocale

Set the locale of the Order. Nothing else will be affected.

setOrderState

Sets the state of an Order

setReturnDynamicFields

Sets dynamic fields of a return. Non specified fields will be left unchanged. Set value to null to remove field.

setShippingTax

Sets the tax percentage factor of a a Delivery's shipping cost.

setStaticValueDiscount

Updates the value of an existing static discount

unsetDeliveryInventory

Removes the inventory from a Delivery. Stock reservations will be updated if there are any.