Module "order"

Description

→ SOAP WSDL

Available methods

Details

void cancel

Cancel an order by supplying its ID

Parameters

  • int $order_id The ID of the order to cancel

int check_executed

Check if an order is already executed by supplying the order's
ID.

Parameters

  • int $order_id The ID of the order to check

Returns

  • int $executed The result, 1 for true, 0 for false

int count

Count the orders for the current user or reseller, depending
on who is asking.

Parameters

  • array $extra_conditions Extra conditions, such as search parameters

Returns

  • int $count The amount of orders found

void execute

Execute an order before a payment has been made. This should
be used with care and is, of course, only available to the
reseller.

Parameters

  • int $order_id The ID of the order to execute

array get_by_id

Get all the information associated with an order by supplying
its ID

Parameters

  • int $id The ID of the order to retrieve

Returns

  • array $info An array containing all the information of this order

array get_by_ogm

Get by ogm

Parameters

  • string $ogm

Returns

  • array $order_data

array get_by_user

Get all orders for a certain user by supplying the user's ID

Parameters

  • int $user_id The ID of the user to fetch orders for

Returns

  • array $order_data An array containing all the information of the orders

array get_paged

Get all orders for the current user or under the current
reseller. This method allows for advanced paging and sorting
methods that allow you to create interactive lists for your
users.

Parameters

  • string $sort The field to sort the items on
  • string $direction Sorting direction, ASC or DESC
  • int $page The page number to fetch
  • array $extra_conditions Extra conditions, such as search parameters
  • int $all

Returns

  • array $order_data An array containing all the information of the orders

float get_price_incl

Get amount inclusive VAT

Parameters

  • int $order_id

Returns

  • float $amount

void mark_paid

Mark an order as being paid. No further action will be taken.
If the order should be executed as well, call the execute()
method AFTER this one.

This is only available to the reseller and only for resellers
configured to do their own invoicing.

Parameters

  • int $order_id The ID of the order to mark as paid

array pay

Pay an order using the supplied payment method. The payment
method that is supplied should of course be active for the
reseller the user is under.

If further action is required (such as redirecting the user),
the needed information is then returned by this method.

Parameters

  • int $order_id The ID of the order to pay
  • int $paymnet_handler_id The ID of the payment handler to use

Returns

  • array $post_parameters Optional extra information to return to the user

void send_email_completed

Send an email to the people involved in the order (user &
invoice contact) stating that their order has been executed.
This is useful in case the user has missed the original email
sent out by the system automatically.

Parameters

  • int $order_id The ID of the order to send the order completed mail for

void send_payment_information

Send the payment information and an overview of the order by
mail to the persons involved in the order (user & invoice
contact).

Parameters

  • int $order_id The ID of the order to send the payment information for