v1

latestOpenAPI 3.0.32026-07-248257161.1 KB

Orders

Returns list of orders

This API returns the list of orders for a merchant.

get/orders

Query parameters

start_datestring date

Example:2023-05-22

Query orders starting from this date. The date format is (YYYY-mm-dd). If omitted, 2023-09-01 is used

end_datestring date

Example:2023-05-24

Query orders from start_date until this date time. The date format is YYYY-mm-dd. If end_date is omitted, current date is used.

status'opened' | 'paid'

Filter by order status. The status filter is combined with start_date and end_date filters

page_offsetinteger

pagination offset, default is 0.

page_sizeinteger

Page size. default value is 20

Response

returns list of orders.

idstring

unique uuid of the order

referencestring required

order reference

customerIdstring

Optional. Unique identifier of the customer, recipient of the order

customerNamestring

Customer Full name, recipient of the payment link

amountnumber double

Optional. Set this value if you want to override the finalAmount below calculated from order details.

currencystring required

order currency

subTotalAmountnumber double

total price of items bought by the customer without tax

deliveryChargesnumber double

shipping costs

deductedAmountnumber double

amount in absolute value to be deducted to final amount

totalTaxnumber double

total tax collected

finalAmountnumber double

final amount to be paid by the customer including tax

status'opened' | 'paid'

Order status

deviceIdstring

device identifier that has initiated the create request.

createdAtstring

The date time that record was created in our system.

updatedAtstring

The date time that record was updated in our system.

Example response

[
  {
    "id": "638d4133957e3caf63e6b79c",
    "reference": "3245GOF456",
    "customerId": "d2d2053b-638d-4133-957e-3caf63e6b79c",
    "customerName": "John Smith",
    "amount": 45000,
    "currency": "XOF",
    "orderDetails": [
      {
        "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
        "name": "pineapple",
        "reference": "SKU56789002",
        "price": 100,
        "quantity": 2.5,
        "discount": 20,
        "taxRate": 5.5,
        "totalPrice": 125
      }
    ],
    "subTotalAmount": 5000,
    "deliveryCharges": 90,
    "deductedAmount": 50,
    "totalTax": 500,
    "finalAmount": 5550,
    "status": "paid",
    "deviceId": "pos-12345",
    "createdAt": "2022-06-20T17:17:11Z",
    "updatedAt": "2022-06-20T17:17:11Z"
  }
]