Ana içeriğe geç

POST /store/{store-code}/terminal — Terminal Oluşturma

📋 Genel Bilgi

Belirli bir mağazaya yeni terminal ekler.

Base URL: {{url}}/store/{{store_code}}/terminal Method: POST Content-Type: application/json


🔐 Headers

HeaderValue
AuthorizationBearer {{masked_jwt_5}}
Content-Typeapplication/json

📥 URL Parametreleri

ParametreTipAçıklamaÖrnek
store-codestringMağaza kodu (path param)"mobildev-mq"

📥 Request Body

{
"name": "Terminal HQ Terminal",
"code": "TERM-004-hq",
"status": "active"
}

Parametreler

AlanTipZorunluAçıklamaÖrnek
namestringTerminal adı"Terminal HQ Terminal"
codestringBenzersiz terminal kodu"TERM-004-hq"
statusstringDurum (active, inactive)"active"

✅ Response — 200 OK

{
"terminalKey": "UGMQoZ82"
}

Response Alanları

AlanTipAçıklama
terminalKeystringOluşturulan terminal benzersiz anahtarı (8 karakter)

❌ Error Responses

Tüm hata yanıtları aşağıdaki formatta döner:

{
"Response": {
"code": 3007,
"description": "A terminal with this code already exists"
},
"Success": false
}
HTTPcodeEnumdescriptionNe Zaman Oluşur
4093005StoreTerminalCodeExistsA terminal with this code already existsGönderilen code, aynı mağazada zaten kayıtlı başka bir terminalde kullanılıyor
5003009StoreTerminalCreateErrorAn error occurred while creating the terminalINSERT sorgusu veritabanı seviyesinde başarısız olduğunda fırlatılır

Örnek — 409 Terminal Code Exists

{
"Response": {
"code": 3005,
"description": "A terminal with this code already exists"
},
"Success": false
}

Örnek — 500 Terminal Create Error

{
"Response": {
"code": 3009,
"description": "An error occurred while creating the terminal"
},
"Success": false
}

📝 Notlar

  • Terminal kodu benzersiz olmalıdır.
  • status: active → Terminal aktif, işlem yapılabilir.
  • status: inactive → Terminal pasif.
  • Hata response'larındaki code alanı AppError enum'undaki uygulama-içi hata kodudur (Response.code); tüm hata gövdesi Response adlı bir alt obje içinde döner, en dışta ayrıca Success: false alanı bulunur.