Get Reconciled Orders By Order Number
Allows developers to retrieve details about a specific order in an e-commerce platform, with the order number as the input parameter. This endpoint can be integrated into an invoicing system to allow merchants to view detailed information about an individual order, such as customer details, payment status, and order total. The response from this endpoint will contain a JSON object that includes all the relevant order information.
API Endpoint
Production Server:
Testing Server:
HTTP Method
GET
Headers
Authorization: The access token for authentication. Received from here
URL Parameters
{orderNumber} - The unique identifier of the order to retrieve details.
Success Response
Status Code: 200 OK
Content-Type: application/json
Body: A JSON object that contains details about the specified order. For more information, 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 payment, if applicable |
Error Responses
- Status Code: 401 Unauthorized
- Status Code: 404 Not Found
Updated 11 months ago