API Referansı
Siparişler
Bağlı platformlardan düşen siparişlerin listelenmesi, durum ilerletme ve iptal akışı.
Taban URL
taban url
https://api.v1.fastsiparis.comGET
/web-api/v1/ordersSiparişleri Listele
Restorana düşen siparişleri listeler. `restaurantId`, `limit`, `cursor` ve yön belirten `dir` (`next`/`prev`) parametreleriyle sayfalanabilir.
Parametreler
| Ad | Konum | Tip | Zorunlu | Seçenekler |
|---|---|---|---|---|
| restaurantId | query | string | Hayır | — |
| limit | query | integer | Hayır | — |
| cursor | query | string | Hayır | — |
| dir | query | string | Hayır | next / prev |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
Kod Örneği
bash
curl --request GET \
--url 'https://api.v1.fastsiparis.com/web-api/v1/orders?restaurantId={restaurantId}&limit={limit}&cursor={cursor}&dir={dir}' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
200OK
JSON
json
{
"success": true,
"data": [
{
"id": "wo_1",
"providerOrderId": "{orderId}",
"restaurantId": "{restaurantId}"
}
]
}GET
/web-api/v1/orders/{orderId}Sipariş Detayı
Tek bir siparişin kalemleri, tutarı ve müşteri bilgisini döndürür.
Parametreler
| Ad | Konum | Tip | Zorunlu | Seçenekler |
|---|---|---|---|---|
| orderId | path | string | Evet | — |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
Kod Örneği
bash
curl --request GET \
--url 'https://api.v1.fastsiparis.com/web-api/v1/orders/{orderId}' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
200OK
JSON
json
{
"success": true,
"data": {
"id": "wo_1",
"pid": "{orderId}"
}
}POST
/web-api/v1/orders/cancel/{orderId}Siparişi İptal Et
Siparişi, platformun kabul ettiği bir neden koduyla iptal eder.
Parametreler
| Ad | Konum | Tip | Zorunlu | Seçenekler |
|---|---|---|---|---|
| orderId | path | string | Evet | — |
Gövde Alanları
| Ad | Tip | Zorunlu |
|---|---|---|
| reason | string | Hayır |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
| Content-Type | application/json |
İstek Gövdesi
JSON
json
{
"reason": "TEST_REASON_CODE",
"note": "Müşteri iptali"
}Kod Örneği
bash
curl --request POST \
--url 'https://api.v1.fastsiparis.com/web-api/v1/orders/cancel/{orderId}' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY' \
--header 'Content-Type: application/json' \
--data '{ "reason": "TEST_REASON_CODE", "note": "Müşteri iptali"}'Yanıtlar
200OK
JSON
json
{
"success": true,
"data": {
"orderId": "{orderId}",
"status": 1600
}
}POST
/web-api/v1/orders/change-status/{orderId}Sipariş Durumunu İlerlet
Siparişi bir sonraki duruma taşır (hazırlanıyor, yolda, teslim edildi).
Parametreler
| Ad | Konum | Tip | Zorunlu | Seçenekler |
|---|---|---|---|---|
| orderId | path | string | Evet | — |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
Kod Örneği
bash
curl --request POST \
--url 'https://api.v1.fastsiparis.com/web-api/v1/orders/change-status/{orderId}' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
200OK
JSON
json
{
"success": true,
"data": {
"orderId": "{orderId}",
"oldStatus": 500,
"newStatus": 600
}
}GET
/web-api/v1/orders/reasons/{orderId}İptal Nedenlerini Getir
Siparişin bağlı olduğu platformun kabul ettiği iptal nedenlerini döndürür.
Parametreler
| Ad | Konum | Tip | Zorunlu | Seçenekler |
|---|---|---|---|---|
| orderId | path | string | Evet | — |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
Kod Örneği
bash
curl --request GET \
--url 'https://api.v1.fastsiparis.com/web-api/v1/orders/reasons/{orderId}' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
200OK
JSON
json
{
"success": true,
"data": {
"reasons": [
{
"id": "reason_1",
"name": "Müşteri İptali"
}
]
}
}POST
/web-api/v1/orders/verify/{orderId}Siparişi Doğrula
Siparişi onaylayarak hazırlanma akışına alır.
Parametreler
| Ad | Konum | Tip | Zorunlu | Seçenekler |
|---|---|---|---|---|
| orderId | path | string | Evet | — |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
Kod Örneği
bash
curl --request POST \
--url 'https://api.v1.fastsiparis.com/web-api/v1/orders/verify/{orderId}' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
200OK
JSON
json
{
"success": true,
"data": {
"message": "Verify completed successfully",
"provider": "yemeksepeti",
"providerOrder": "{orderId}"
}
}POST
/web-api/v1/orders/reports/markSiparişi Raporlandı Olarak İşaretle
Siparişi raporlandı olarak damgalar; listeden düşer.
Gövde Alanları
| Ad | Tip | Zorunlu |
|---|---|---|
| providerOrderId | string | Evet |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
| Content-Type | application/json |
İstek Gövdesi
JSON
json
{
"providerOrderId": "{providerOrderId}"
}Kod Örneği
bash
curl --request POST \
--url 'https://api.v1.fastsiparis.com/web-api/v1/orders/reports/mark' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY' \
--header 'Content-Type: application/json' \
--data '{ "providerOrderId": "{providerOrderId}"}'Yanıtlar
200OK
JSON
json
{
"success": true,
"data": {
"providerOrderId": "{providerOrderId}",
"isReport": true
}
}GET
/web-api/v1/orders/reports/pendingRaporlanmamış Siparişleri Listele
Muhasebeye aktarılmayı bekleyen siparişleri döndürür.
Parametreler
| Ad | Konum | Tip | Zorunlu | Seçenekler |
|---|---|---|---|---|
| restaurantId | query | string | Hayır | — |
| limit | query | integer | Hayır | — |
| cursor | query | string | Hayır | — |
| dir | query | string | Hayır | next / prev |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
Kod Örneği
bash
curl --request GET \
--url 'https://api.v1.fastsiparis.com/web-api/v1/orders/reports/pending?restaurantId={restaurantId}&limit={limit}&cursor={cursor}&dir={dir}' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
200OK
JSON
json
{
"success": true,
"data": []
}POST
/web-api/v1/orders/retry-webhookkoleksiyonWebhook Retry
Ulaşmayan webhook bildirimini yeniden gönderir.
Gövde Alanları
| Ad | Tip | Zorunlu |
|---|---|---|
| webhookOrderId | string | Evet |
| url | string | Evet |
| headers | object | Evet |
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
| Content-Type | application/json |
İstek Gövdesi
JSON
json
{
"webhookOrderId": "{webhookOrderId}",
"url": "https://example.com/webhook",
"headers": {
"X-Test": "true"
}
}Kod Örneği
bash
curl --request POST \
--url 'https://api.v1.fastsiparis.com/web-api/v1/orders/retry-webhook' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY' \
--header 'Content-Type: application/json' \
--data '{ "webhookOrderId": "{webhookOrderId}", "url": "https://example.com/webhook", "headers": { "X-Test": "true" }}'Yanıtlar
200OK
JSON
json
{
"success": true,
"data": {
"message": "webhook retry delivered",
"statusCode": 200
}
}GET
/web-api/v1/orders/grouped-paymentskoleksiyonGruplanmış Ödemeleri Getir
Siparişleri ödeme tipine göre gruplayıp toplamlarını döndürür.
Header'lar
| Ad | Değer |
|---|---|
| Authorization | Bearer POSENTEGRA_API_KEY |
Kod Örneği
bash
curl --request GET \
--url 'https://api.v1.fastsiparis.com/web-api/v1/orders/grouped-payments' \
--header 'Authorization: Bearer POSENTEGRA_API_KEY'Yanıtlar
200OK
JSON
json
{
"success": true
}