List purchase orders
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/purchase-orders \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/purchase-orders"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://staging-api.usetyms.com/v1/adam/purchase-orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Purchase orders retrieved successfully",
"data": [
{
"uuid": "po-uuid-1",
"transaction_type": "purchase_order",
"status": "draft",
"document_number": "PO-0042",
"narration": "Q2 stock replenishment",
"amount": 450000,
"currency": "NGN"
}
]
}Purchase Orders
List purchase orders
Return the paginated list of purchase orders. Convert to restock when goods arrive.
GET
/
purchase-orders
List purchase orders
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/purchase-orders \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/purchase-orders"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://staging-api.usetyms.com/v1/adam/purchase-orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Purchase orders retrieved successfully",
"data": [
{
"uuid": "po-uuid-1",
"transaction_type": "purchase_order",
"status": "draft",
"document_number": "PO-0042",
"narration": "Q2 stock replenishment",
"amount": 450000,
"currency": "NGN"
}
]
}Authorizations
Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.
Query Parameters
Available options:
asc, desc Page number.
Page size.
Full-text search.
Pass 1 to return only data without the status/message wrapper.
Available options:
1 Response
200 - application/json
Purchase order list