Skip to content

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

Sipariş Geri Bildirimleri

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

Operations

[Mock] Sipariş Geri Bildirimleri

Request

⚠️ Not: Bu endpoint sadece API dokümantasyonumuzda ilettiğimiz örnek callback'leri göstermek içindir.
Gerçek bir API çağrısı değildir. Payload'lar sistemimiz tarafından ilettiğiniz callback endpointine gönderilir.

Düzenli durumlar: Bir siparişin normal akışında bu durumlar sırayla iletilir.
  • inQueue
  • waiting
  • onTheWayForPickUp
  • onPickUpAddress
  • onDelivery
  • onDeliveryAddress
  • delivered
İade Durumları: Siparişin teslim alınıp yoldayken iptal edilme durumları. Siparişi kurye teslim aldıktan sonra teslim edene kadar bu durumlar iletilebilir.
  • waitingForReturn
  • onTheWayForReturn
  • onReturnAddress
  • returned
Transfer Durumları: Siparişin başka kuryeye transfer edilme durumları. Siparişi kurye teslim aldıktan sonra teslim edene kadar bu durumlar iletilebilir.
  • waitingForTransfer
  • onTheWayForTransfer
  • onTransferAddress
İptal Durumları: Sipariş herhangi bir durumda iken bu durum gelebilir.
  • canceled
Security
SampleCallbackHeader
Bodyapplication/json
orderobject
serverTimestring(date-time)
curl -i -X POST \
  https://developers.vigo.ist/_mock/docs/__examples/delivery-callbacks \
  -H 'Content-Type: application/json' \
  -H 'SampleCallbackHeader: YOUR_API_KEY_HERE' \
  -d '{
    "order": {
      "id": "627e56856649f152aa31f385",
      "orderNumber": "12345",
      "state": "inQueue",
      "description": "",
      "platform": "trendyol",
      "tracking": {
        "url": "",
        "shortURL": ""
      },
      "assignedCourier": null
    },
    "serverTime": "2022-05-13T13:01:14.946Z"
  }'

Responses

Başarılı response. Vigo için callback iletildi anlamına gelmektedir.