Quickstart
Create your first delivery task in under five minutes.
Get your credentials
Ask your Katch account manager for an API key and your seller id. See Authentication for how they are used.
Check your wallet
Wallet accounts need enough balance before a task can be created.
curl https://graphql.katchkw.com/rest/tasks/wallet-balance \
-H "Authorization: apikey $KATCH_API_KEY" \
-H "x-seller-id: $KATCH_SELLER_ID"{ "walletAmount": 125.5 }Create a task
curl -X POST https://graphql.katchkw.com/rest/tasks \
-H "Authorization: apikey $KATCH_API_KEY" \
-H "x-seller-id: $KATCH_SELLER_ID" \
-H "Content-Type: application/json" \
-d '{
"orderNumber": "ORD-1001",
"customerName": "Jane Doe",
"customerNumber": "96550000000",
"deliveryZone": "Salmiya",
"collectCash": true,
"totalAmount": "4.750",
"deliveryLocation": {
"latitude": 29.3375,
"longitude": 48.0758,
"fullAddress": ["Salmiya, Block 11", "Baghdad Street", "Building 53"]
}
}'Follow the delivery
Either poll Get a task by ID or, better, register a webhook and get every status change pushed to you.