Sell Via App
API Reference

GENERAL

Customer

Document

Document Line

FAM 1

Fam 2

Orders

Orders Lines

Product

API Documentation - Order List

Endpoint

GET /order/list

Parameters

The following parameters can be included in the request:

Parameter Type Description Required
clcleunik string The unique customer code Yes, if use is clcleunik
idCustomer int The customer ID Yes, if use is id
use string Specifies which parameter to use for the query. Can be clcleunik or id No (defaults to clcleunik)
limit int Limits the number of results returned No

Response

The response is a JSON object containing the following fields:

{
    "success": "true or false",
    "message": "Description of the response",
    "result": {
        "order": [
            {
                "clcleunik": "Unique customer code",
                "communication": "Communication of the purchase",
                "date": "Date of the order",
                "hour": "Hour of the order",
                "confirmation_date": "Confirmation date of the order",
                "confirmation_heure": "Confirmation hour of the order",
                "totalHTVA": "Total amount without VAT",
                "totalTVAC": "Total amount with VAT",
                "language": "Order language",
                "xmlFile": "XML file of the order",
                "guid": "GUID of the order"
            }
            // Additional order items
        ]
    }
}

Error Handling

If an error occurs, the response will contain the following fields:

{
    "success": "false",
    "message": "Error description"
}

Example Request

GET /order/list?clcleunik=12345&use=clcleunik&limit=10

Example Response

{
    "success": true,
    "message": "ORDER List",
    "result": {
        "order": [
            {
                "clcleunik": "12345",
                "communication": "Purchase communication",
                "date": "2024-06-07",
                "hour": "14:30",
                "confirmation_date": "07/06/2024",
                "confirmation_heure": "14:30",
                "totalHTVA": "1000.00",
                "totalTVAC": "1200.00",
                "language": "en",
                "xmlFile": "order.xml",
                "guid": "unique-guid-12345"
            }
        ]
    }
}