Skip to main content

Get All Order Status

This API allows you to retrieve the status of orders. You can either fetch all orders or filter them by a specific status (e.g., Paid or Invoiced) by including the type query parameter. If no type is provided, the API will return all orders regardless of their status.


Endpoint

  • Fetch all orders:
GET https://demo-api.frontpayment.no/api/v1/connect/orders/status
  • Fetch orders with the status "Paid":
https://demo-api.frontpayment.no/api/v1/connect/orders/status?type=Paid

Query Parameters

type (optional): Filter the orders by their status. You can use one of the following values:

  • SENT
  • PAID
  • CANCELLED
  • EXPIRED
  • INVOICED
  • REFUNDED
  • PARTIAL REFUNDED

Authorization

To access this endpoint, include a Bearer Token in the Authorization header of your request. You can obtain this token from Frontpayment.

Example Authorization Header: Authorization: Bearer YOUR_FRONTPAID_BEARER_TOKEN

Response

A successful request will return a 200 status with the following JSON payload:

{
    "status_code": 200,
    "status_message": "OK",
    "message": "Order Status Retrieved Successfully",
    "is_data": true,
    "data": [
      {
        "uuid": "String",
        "status": "String"
      },
      {
        "uuid": "String",
        "status": "String"
      }
    ]
}

API returns a 510 error, it means something failed on the server side

{
    "status_code": 510,
    "status_message": "Execution Exception Occurred",
    "message": "Something Went Wrong",
    "is_error": true,
    "errors": "Array"
}