Developer Kolay Deniz Market API v1.0 Mağazaya dön
API referansı · 14 uç nokta

Me

Oturum açmış kullanıcının profili, tekneleri ve adres defteri.

GET /v1/me Bearer

Oturum açmış kullanıcının profili

Yanıtlar

DurumGövdeAçıklama
200 MeResponse Profil.
401 ApiError missing_token, invalid_token veya unauthenticated.
PATCH /v1/me Bearer

Profili günceller

Boş gövde reddedilir. Bir alanı temizlemek için null gönderin.

İstek gövdesi UpdateMeRequest

Yanıtlar

DurumGövdeAçıklama
200 MeResponse Güncel profil.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
409 ApiError email_taken.
GET /v1/me/tax-profile Bearer

Fatura kimliği

Kayıt yoksa 200 ile null döner, 404 değil.

Yanıtlar

DurumGövdeAçıklama
200 Fatura profili veya null.
401 ApiError missing_token, invalid_token veya unauthenticated.
PUT /v1/me/tax-profile Bearer

Fatura kimliğini oluşturur veya günceller

İstek gövdesi UpsertTaxProfileRequest

Yanıtlar

DurumGövdeAçıklama
200 TaxProfileDto Güncel fatura profili.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
DELETE /v1/me/tax-profile Bearer

Fatura kimliğini siler

Yanıtlar

DurumGövdeAçıklama
204 Silindi.
401 ApiError missing_token, invalid_token veya unauthenticated.
POST /v1/me/push-tokens Bearer

Cihaz push token'ı kaydeder

Her rol için geçerlidir — transfer partnerleri de bildirim alır. Başka bir hesapta kayıtlı bir token, çağıran hesaba taşınır.

İstek gövdesi RegisterPushTokenRequest

Yanıtlar

DurumGövdeAçıklama
204 Kaydedildi.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
GET /v1/me/vessels Bearer

Kullanıcının tekneleri

Yanıtlar

DurumGövdeAçıklama
200 VesselDto[] Tekne listesi.
401 ApiError missing_token, invalid_token veya unauthenticated.
POST /v1/me/vessels Bearer

Tekne ekler

İstek gövdesi CreateVesselRequest

Yanıtlar

DurumGövdeAçıklama
201 VesselDto Oluşturuldu.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
PATCH /v1/me/vessels/{id} Bearer

Tekneyi günceller

İstek gövdesi UpdateVesselRequest

Yanıtlar

DurumGövdeAçıklama
200 VesselDto Güncel tekne.
400 ApiError validation_failed — gövde veya query şemaya uymuyor (details).
401 ApiError missing_token, invalid_token veya unauthenticated.
404 ApiError vessel_not_found.
DELETE /v1/me/vessels/{id} Bearer

Tekneyi siler

Kalıcı silme. Bu tekneye bağlı teslimat adresleri de silinir.

Yanıtlar

DurumGövdeAçıklama
204 Silindi.
401 ApiError missing_token, invalid_token veya unauthenticated.
404 ApiError vessel_not_found.
GET /v1/me/delivery-locations Bearer

Teslimat adres defteri

Yanıtlar

DurumGövdeAçıklama
200 DeliveryLocationDto[] Adres listesi.
401 ApiError missing_token, invalid_token veya unauthenticated.
POST /v1/me/delivery-locations Bearer

Teslimat adresi ekler

İki ayrı şekil vardır, tek şeklin opsiyonel alanları değil. Diğer şekle ait alanlar gönderilemez (yalnızca null kabul edilir) — sessizce atılan bir lat, kaydettiğini sanan istemci için veri kaybıdır.

İstek gövdesi CreateDeliveryLocationRequest

Yanıtlar

DurumGövdeAçıklama
201 DeliveryLocationDto Oluşturuldu.
400 ApiError validation_failed, pin_outside_anchorage veya location_not_serviceable.
401 ApiError missing_token, invalid_token veya unauthenticated.
404 ApiError vessel_not_found, marina_not_found veya anchorage_not_found.
PATCH /v1/me/delivery-locations/{id} Bearer

Teslimat adresini günceller

kind ve ait olduğu yer alanları PATCH'te de zorunludur: bunlar dört ayrı alan değil, tek bir değerdir. Aksi halde kayıtlı bir marina adresi, pini olmayan bir demirleme adresine yarım dönüştürülebilirdi.

İstek gövdesi UpdateDeliveryLocationRequest

Yanıtlar

DurumGövdeAçıklama
200 DeliveryLocationDto Güncel adres.
400 ApiError validation_failed, pin_outside_anchorage veya location_not_serviceable.
401 ApiError missing_token, invalid_token veya unauthenticated.
404 ApiError delivery_location_not_found.
DELETE /v1/me/delivery-locations/{id} Bearer

Teslimat adresini siler

Yanıtlar

DurumGövdeAçıklama
204 Silindi.
401 ApiError missing_token, invalid_token veya unauthenticated.
404 ApiError delivery_location_not_found.