Skip to content
Alım Noktası
/
Alım Noktası Fiyat Hesaplama

Vigo API Dokümantasyonu

Bu dökümantasyon, Vigo API sürümüne ait endpointleri ve entegrasyon detaylarını içermektedir. API, sipariş yönetimi ve sistemler arası veri entegrasyonu gibi işlevler için kullanılabilir.

İletişim

Başvuru ve sorularınız için integration@vigo.ist adresine mail iletebilirsiniz.

Download OpenAPI description
docs.json
docs.yaml
Overview
Vigo Integration Support

integration@vigo.ist

Languages
Servers
Mock server

https://developers.vigo.ist/_mock/docs/

Development server

https://app-dev.vigo.ist/api/v2/

Production server

https://app.vigo.ist/api/v2/

Kimlik Doğrulama

Kimlik ve Yetkilendirme ile ilgili işlemleri içermektedir.

API'yi kullanabilmek için bir erişim token'ı alınmalıdır. Hesabınız oluşturulduğunda size özel clientId ve clientSecret bilgileri e-posta yoluyla iletilir. Bu bilgiler kullanılarak token alınması gerekmektedir.
Token alındıktan sonra, tüm yetkili isteklerde header bilgisi içinde x-auth-token key'i ile iletilmelidir.

Operations

Sipariş

Sipariş ile ilgili işlemleri içermektedir. Sipariş için gerekli olan statü güncelleme işlemleri için bu endpointleri inceleyebilirsiniz.

Operations

Alım Noktası

Siparişlerin kurye tarafından alınacağı noktayı ifade eder

Mevcut pickUp onboardingStatus (alım noktası durumları) değerleri:

  • candidate (Aday)
  • approved (Onaylandı)
  • rejected (Reddedildi)
  • pending (Belge Onay Bekliyor)
Operations

Alım Noktası Oluşturma

Request

Sipariş isteği sadece önceden tanımlı ve onaylı alım noktaları için yapılmalıdır. Başarılı sipariş isteği için mutlaka alım noktası yaratmalısınız ve alım noktanızın durumunun aktif olması gereklidir.

Security
XAuthToken
Bodyapplication/jsonrequired
namestringrequired

Pickup Noktası Adı

Example: "Test şubesi"
addressstring

Pickup Noktası Adresi

Example: "Kadıköy Kozyatağı Gelişim Sokak No:12"
citystring

Şehir Bilgisi

Example: "İstanbul"
districtstring

İlçe Bilgisi

Example: "Kadıköy"
locationobject

Konum bilgisi

authorizedPhonestringrequired

Yetkili telefon numarası

Example: 5320000000
authorizedEmailstringrequired

Yetkili e-posta adresi

Example: "ornek@firma.com"
callbackobject

Durum güncellemelerinde bildirim yapılacak callback bilgileri.

Eğer callback bilgisi iletilirse, pickup noktası onaylandığında, aşağıdaki body ile POST methodu kullanılarak belirtilen url'e bir istek gönderilir:

{
  "id": "6881e2c77d092a3b9377f048",
  "externalId": "externalId95",
  "onboardingStatus": "approved",
  "name": "fındık - Test - pickuptest955",
  "city": "istanbul",
  "district": "Fındıklı",
  "authorizedEmail": "test@mail.vigo",
  "authorizedPhone": "05327981731",
  "address": "fındıklı mahallesi senem sokak no:39-31",
  "location": {
    "latitude": 40.9735869,
    "longitude": 29.1393237
  },
  "serverTime": "2025-07-24T07:39:17.929Z"
}
externalIdstring

Dış sistemdeki referans ID

Example: "EXT123456"
curl -i -X POST \
  https://developers.vigo.ist/_mock/docs/pickupPoint \
  -H 'Content-Type: application/json' \
  -H 'x-auth-token: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Test şubesi",
    "address": "Kadıköy Kozyatağı Gelişim Sokak No:12",
    "city": "İstanbul",
    "district": "Kadıköy",
    "location": {
      "longitude": 42,
      "latitude": 42
    },
    "authorizedPhone": 5320000000,
    "authorizedEmail": "ornek@firma.com",
    "callback": {
      "url": "https://ornek-callback.com/pickup-status",
      "tokenHeader": "Authorization",
      "token": "Bearer abcdef123456"
    },
    "externalId": "EXT123456"
  }'

Responses

Başarılı

Bodyapplication/json
successboolean
Example: true
messagestring
Example: "Pick up noktası oluşturuldu"
Response
application/json
{
  "success": true,
  "message": "Pick up noktası oluşturuldu"
}

Alım Noktaları Listeleme

Request

Sistemde kayıtlı olan alım noktalarınız ile ilgili ayrıntıları bu endpoint'in response'unda görebilirsiniz.

Security
XAuthToken
curl -i -X GET \
  https://developers.vigo.ist/_mock/docs/pickupPoint \
  -H 'x-auth-token: YOUR_API_KEY_HERE'

Responses

Başarılı

Bodyapplication/json
pickupPointsArray of objects
serverTimestring(date-time)
Example: "2025-07-24T09:22:08.546Z"
Response
application/json
{
  "pickupPoints": [
    { … }
  ],
  "serverTime": "2025-07-24T09:22:08.546Z"
}

Alım Noktası Fiyat Hesaplama

Request

Security
XAuthToken
Path
idstringrequired

Alım Noktası Id

Example: 6881dcf9219d5b001e54d17a
Bodyapplication/jsonrequired
receiverobjectrequired
receiver.​addressstring
Example: "Gülbahar Mahallesi, Şahinler sokak, Şişli, İstanbul"
receiver.​locationobjectrequired
receiver.​location.​latitudenumberrequired
Example: 41.012345
receiver.​location.​longitudenumberrequired
Example: 28.987654
curl -i -X POST \
  https://developers.vigo.ist/_mock/docs/pickupPoint/6881dcf9219d5b001e54d17a/calculatePrice \
  -H 'Content-Type: application/json' \
  -H 'x-auth-token: YOUR_API_KEY_HERE' \
  -d '{
    "receiver": {
      "address": "Gülbahar Mahallesi, Şahinler sokak, Şişli, İstanbul",
      "location": {
        "latitude": 41.012345,
        "longitude": 28.987654
      }
    }
  }'

Responses

Başarılı

Bodyapplication/json
pricenumber
Example: 100
Response
application/json
{
  "price": 100
}

Sipariş Geri Bildirimleri

Tarafınıza iletilen callback örnekleri içermektedir.

Operations