HostFact API versie 3.1



Bestelling

Bestellingen zijn te beheren via de controller 'order'.



list

Middels deze functie kunt u een lijst met bestellingen ophalen die voldoen aan de meegegeven parameters.
Voorbeeldbestand: /voorbeelden/order/order.list.php


Invoerparameters:
Veldnaam Waarde Omschrijving
status string Bestelstatus, zie variabelen-lijst
offset int Standaard: 0
limit int Standaard: 1000
sort string Standaard: OrderCode
order 'ASC' of 'DESC' Standaard: DESC
searchat string Welke velden doorzocht moeten worden.
Standaard: OrderCode|CompanyName|SurName
searchfor string Zoekterm
created filter_datetime Filtermogelijkheid op aanmaakdatum
modified filter_datetime Filtermogelijkheid op wijzigingsdatum
date filter_datetime Filtermogelijkheid op besteldatum

Voorbeeld invoer:
<?php

require_once("../hostfact_api.php");

$api = new HostFactAPI();

$orderParams = array(
				// Get all orders which are new
				'status' 		=> '0'
);

$response = $api->sendRequest('order', 'list', $orderParams);

print_r_pre($response);

?>

Voorbeeld uitvoer:
Array
(
    [controller] => order
    [action] => list
    [status] => success
    [date] => 2022-11-24T12:00:00+02:00
    [totalresults] => 1
    [currentresults] => 1
    [offset] => 0
    [filters] => Array
        (
            [status] => 0
        )

    [orders] => Array
        (
            [0] => Array
                (
                    [Identifier] => 1
                    [OrderCode] => B0001
                    [Debtor] => 1
                    [CompanyName] => Company X
                    [Initials] => John
                    [SurName] => Jackson
                    [AmountExcl] => 155.00
                    [AmountIncl] => 187.55
                    [Date] => 2018-01-14 14:10:51
                    [Status] => 0
                    [Modified] => 2022-11-24 11:00:00
                )

        )

)