Get an order, or search them
eurodns_order_getRetrieve order details with lines and delivery status, filtering by ID, statuses, dates, search term, or pagination.
Instructions
Returns one order with its lines and their delivery status by id, or searches orders when id is omitted — by statuses, startDate and endDate, a free-text term, or deliveryInProgress — paged with page and size. Use it to learn what happened to a subscription that was ordered but never became active; the filters are ignored when id is given. The invoice raised for an order is in eurodns_invoice_get, not here.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Numeric id of the order to return with its lines. Omit it to search orders with the filters below. | |
| page | No | 1-based page number. There is no page meaning everything: walk pages until a short one comes back. | |
| size | No | Results per page, 1 to 500. A wide page is truncated by the character limit, so prefer a filter to a large size. | |
| term | No | The search term allowing to search orders based on the description of its order lines. | |
| endDate | No | The parameter allowing to search orders before the given date | |
| statuses | No | Keep only orders in these payment statuses, e.g. PAID, PENDING_PAYMENT or REFUSED. | |
| ordersIds | No | The list of order identifiers. | |
| sortField | No | Result field to sort on, spelled as in the response items. Unsorted when omitted. | |
| sortOrder | No | ASC or DESC; only read with sortField. | |
| startDate | No | The parameter allowing to search orders after the given date | |
| orderLineIds | No | The list of order line id related to the orders. | |
| deliveryInProgress | No | The delivery status of the orders. An order delivery is considered in progress once the order payment has been processed but no all order lines are delivered yet. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Response body as returned by the API. | |
| status | Yes | Upstream HTTP status code. |