Get Orders by Date Range

This API endpoint allows developers to retrieve a list of orders within a specific date range. The API requires authentication through an access token, and the input parameters are the 'from' and 'to' dates in the format of YYYY-MM-DD.

Request Type:

GET

Endpoint

📘

Production Server:

https://restapi.paylink.sa/api/getOrdersByDateRange

📘

Testing Server:

https://restpilot.paylink.sa/api/getOrdersByDateRange

Request Headers:

Header	Required	Description
Authorization	Yes	An access token obtained through the authentication process
accept	Yes	The expected response format. application/json

Query Parameters

Parameter	Value Type	Required	Description
from	string (YYYY-MM-DD)	Yes	The start date for the date range to retrieve orders from
to	string (YYYY-MM-DD)	Yes	The end date for the date range to retrieve orders from

Response Body:

The response will be an array of JSON objects that includes all relevant information for the orders retrieved within the specified date range. For more details, click here.

Name	Type	Description
orderId	integer	The unique identifier of the order
orderNumber	string	The unique order number
orderDate	date	The date and time the order was placed, in Unix timestamp
orderAmount	float	The total amount of the order, in the currency
paylinkFees	float	The fees charged by Paylink, if applicable
paylinkVat	float	The VAT charged by Paylink, if applicable
note	string	A note associated with the order
clientName	string	The name of the client who placed the order
clientMobile	string	The phone number of the client who placed the order
isReconciled	boolean	Indicates whether the order has been reconciled
settlementNumber	string	The settlement number, if applicable
settlementBank	string	The bank account number for the settlement, if applicable
settlementAmount	float	The amount settled, if applicable
settlementIban	string	The IBAN for the settlement, if applicable

Error Responses

• Status Code: 401 Unauthorized
• Status Code: 404 Not Found