posentegra Kaynaklar
Şemalar
Giriş
Aşağıdaki şemalar istek gövdelerinde kullanılan alanları listeler; hepsi application/json gövdesinde gönderilir.
Zorunlu sütunu "Evet" ise alan gövdede yoksa istek 400 Bad Request döner; "—" işaretli alanlar isteğe bağlıdır. Tipler doğrudan JSON tipleridir (string, number, object).
- İşletme ve restoran oluşturma/güncelleme uçları
CreateBusinessRequestveCreateRestaurantRequest'i kullanır. - Restoran bağlama, paket atama, sipariş iptali ve rapor işaretleme uçları sırasıyla
LinkRestaurantRequest,AssignPackageRequest,CancelOrderRequest,MarkReportDoneRequest'i kullanır.
CreateBusinessRequest
POST /web-api/v1/businesses, PUT /web-api/v1/businesses/{businessId}
| Alan | Tip | Zorunlu | Not |
|---|---|---|---|
| name | string | Evet | — |
| description | string | — | — |
| vatNumber | string | — | — |
| taxOffice | string | — | — |
| address | string | — | — |
| city | string | — | — |
| country | string | — | — |
| zipCode | string | — | — |
| phone | string | — | — |
| string | — | — |
UpdateBusinessRequest ayrı bir şema değil, bu şemanın takma adıdır.
CreateRestaurantRequest
POST /web-api/v1/restaurants, PUT /web-api/v1/restaurants/{restaurantId}
| Alan | Tip | Zorunlu | Not |
|---|---|---|---|
| businessId | string | — | — |
| name | string | Evet | — |
| description | string | — | — |
| address | string | — | — |
| lat | number | — | — |
| lon | number | — | — |
| config | object | — | Serbest biçimli nesne; alanları platforma göre değişir. |
| paymentMatchingUrl | string | — | — |
| paymentMatchingHeaders | object | — | — |
UpdateRestaurantRequest bu şemanın takma adıdır.
LinkRestaurantRequest
POST /web-api/v1/businesses/{businessId}/restaurants
| Alan | Tip | Zorunlu | Not |
|---|---|---|---|
| restaurantId | string | Evet | — |
AssignPackageRequest
POST /web-api/v1/restaurants/{restaurantId}/assign-package
| Alan | Tip | Zorunlu | Not |
|---|---|---|---|
| userPackageId | string | Evet | — |
| businessName | string | — | — |
CancelOrderRequest
POST /web-api/v1/orders/cancel/{orderId}
| Alan | Tip | Zorunlu | Not |
|---|---|---|---|
| reason | string | — | — |
Zorunlu alan yok; kabul edilen gerekçeler GET /web-api/v1/orders/reasons/{orderId} ucundan çekilir.
MarkReportDoneRequest
POST /web-api/v1/orders/reports/mark
| Alan | Tip | Zorunlu | Not |
|---|---|---|---|
| providerOrderId | string | Evet | — |
Notlar
- Alan tabloları yalnızca ad, tip ve zorunluluk bilgisini taşır; biçim ve değer aralığı doğrulaması sunucu tarafında uygulanır.
- Bu sayfa yalnızca istek gövdelerini tanımlar. Yanıt gövdeleri için ilgili uç noktanın referans sayfasındaki örnek yanıtlara bakın.
- Şema adları, alan adları, tipleri ve zorunluluk bilgisi yayımlanan OpenAPI tanımından (
v1.0.1) birebir alındı; uydurulmuş ad yoktur. Tanımda ayrıca gövde alanı listelenmeyen iki şema daha var (UpdateBusinessRequest,UpdateRestaurantRequest); alanları belirtilmediği için bu sayfaya alınmadı. dirsorgu parametresi (GET /web-api/v1/orders,GET /web-api/v1/orders/reports/pending) yalnızcanextveyaprevdeğerini kabul eder — OpenAPI tanımındaki tek enum budur.