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.

Endpoint

GET /api/getOrdersByDateRange?from={YYYY-MM-DD}&to={YYYY-MM-DD}

Request Headers

HeaderRequiredDescription
AuthorizationYesBearer token provided by Authentication Endpoint
AcceptYesIt must be set to application/JSON.
Content-TypeYesIt must be set to application/JSON.
{
  "Authorization": "Bearer [id_token]",
  "Accept": "application/json",
  "Content-Type": "application/json"
}

Query Parameters

ParameterValue TypeRequiredDescription
fromString (YYYY-MM-DD)YesThe start date for the date range to retrieve orders from
toString (YYYY-MM-DD)YesThe 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.

NameTypeDescription
orderIdIntegerThe unique identifier of the order
orderNumberStringThe unique order number
orderDateDateThe date and time the order was placed, in Unix timestamp
orderAmountFloatThe total amount of the order, in the currency
paylinkFeesFloatThe fees charged by Paylink, if applicable
paylinkVatFloatThe VAT charged by Paylink, if applicable
noteStringA note associated with the order
clientNameStringThe name of the client who placed the order
clientMobileStringThe phone number of the client who placed the order
isReconciledBooleanIndicates whether the order has been reconciled
settlementNumberStringThe settlement number, if applicable
settlementBankStringThe bank account number for the settlement, if applicable
settlementAmountFloatThe amount settled, if applicable
settlementIbanStringThe IBAN for the settlement, if applicable

Error Responses

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