Skip to content
Sipariş
/
Sipariş Hazırlandı

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

Sipariş Oluşturma

Request

Bu endpoint sipariş oluşturmanız için kullanılmaktadır. Oluşturulan sipariş bir kuryeye atanır ve kurye siparişi alım noktasından teslim alır. Teslim alma işlemi tamamlandıktan sonra sipariş müşteriye teslim edilmek üzere yola çıkar. Bazı durumlarda, kurye teslim alma noktasına bazı ürünleri geri bırakmak için dönebilir.

Endpoint Özellikleri:

  • Siparişler, birden çok ürün içerebilir.
  • Teslimat sırasında kurye ürün iade edilmesi üzerine bir bildirim alırsa iade süreci başlatılabilir.
  • Sipariş Geri Bildirimleri için url paylaşmanız durumunda, teslimat ile ilgili statü güncellemeleri tarafınıza bildirilecektir.
Security
XAuthToken
Bodyapplication/json
One of:
receiverNamestringrequired
receiverLocationobject(LocationForReceiver)required
receiverLocation.​latnumberrequired
Example: 45.2345
receiverLocation.​lonnumberrequired
Example: 45.2345
receiverAddressstringrequired
receiverAddressDetailstring
receiverPhonestringrequired
pickupPointBelirsiz alım noktası (object) or Kayıtlı Alım Noktası (Kayıtlı Alım Noktası (object))required
Any of:
pickupPoint.​namestringrequired
pickupPoint.​addressstringrequired
pickupPoint.​locationobject(Location)required
pickupPoint.​location.​longitudenumberrequired
Example: 45.2345
pickupPoint.​location.​latitudenumberrequired
Example: 45.2345
pickupPoint.​phonestringrequired
Example: "05323456789"
courierTypestring(CourierType)required

Belirtilen kurye seçenekleri

Enum"motorCourier""carCourier""pedestrian""bicycleCourier"
orderTypestringrequired

Bu alan siparişin normal bir sipariş mi yoksa siparişin iade mi olduğunu anlamak için kullanılır.

Default "delivery"
Enum"delivery""productReturn"
callbackobject

Teslimat Süreçleri için Geri Bildirim

orderNumberstringrequired
notestring
desinumber>= 0.001
paymentTypestringrequired

Payment type enum alanları:

  • paid: Paid

  • creditCard: Credit Card

  • cash: Cash

  • ticketRestaurant: Ticket Restaurant

  • sodexo: Sodexo

  • multinet: Multinet

  • setCard: SetCard

  • yemekmatik: Yemekmatik

  • metropol: Metropol

  • cioCard: CIO Card

  • paye: Paye Card

  • winWin: WinWin

  • tokenFlex: TokenFlex

paymentMethodstringrequired

Kapıda ödeme almak istiyorsanız, "cod" ödeme yöntemini göndermeniz zorunludur.

  • online: Ödeme kredi/banka kartı veya dijital cüzdan aracılığıyla online olarak tamamlanır.
  • cod: Kapıda Ödeme; sipariş teslim edildiği zaman müşteriden tahsil edilir.
Enum"cod""online"
pricestring
dontRingTheBellboolean
barcodestring
receiptNumberstring
platformstringrequired
productsArray of objects(Product)required
products[].​productNamestringrequired
products[].​ingredientsstringrequired
products[].​amountintegerrequired
products[].​returnboolean
products[].​pricestring
products[].​desinumber>= 0.001
curl -i -X POST \
  https://developers.vigo.ist/_mock/docs/order \
  -H 'Content-Type: application/json' \
  -H 'x-auth-token: YOUR_API_KEY_HERE' \
  -d '{
    "pickupPoint": {
      "id": "6881e0dd1a5da2001e118180"
    },
    "callback": {
      "url": "http://callbackurl.example.com",
      "token": "XXXYYYXXXVVVZZZ",
      "tokenHeader": "x-api-key"
    },
    "receiverName": "Müşteri Adı Soyadı",
    "receiverAddress": "Gülbahar Mahallesi, Şahinler sokak, Şişli, İstanbul",
    "receiverAddressDetail": "Yazılım Apartmanı",
    "receiverLocation": {
      "lon": 45.2345,
      "lat": 45.2345
    },
    "receiverPhone": "05550000000",
    "courierType": "motorCourier",
    "orderType": "delivery",
    "orderNumber": "12345",
    "note": "Çatal Bıçak İstemiyorum",
    "paymentType": "cash",
    "paymentMethod": "online",
    "price": "12.00",
    "dontRingTheBell": true,
    "barcode": "",
    "receiptNumber": "FİŞNO123",
    "platform": "trendyol",
    "products": [
      {
        "productName": "Kola",
        "ingredients": "şekersiz",
        "amount": 0,
        "return": false,
        "price": "12.00",
        "desi": 0.001
      }
    ]
  }'

Responses

Başarılı Sipariş Oluşturma Response'u

Bodyapplication/json
orderobject
serverTimestring(date-time)(ServerTime)

senkronizasyon amaçlı sunucu zamanı

Example: "2020-07-14T17:29:15.646Z"
Response
application/json
{
  "order": {
    "id": "627d0a69dc1f4a3d10ff5db5",
    "orderNumber": "12345",
    "state": "inQueue"
  },
  "serverTime": "2022-05-12T13:23:54.632Z"
}

Sipariş Bilgisi (OrderId veya OrderNumber İle)

Request

id veya orderNumber parametrelerinden en az biri zorunludur.

Security
XAuthToken
Query
idstring

Sipariş Kimliği

Example: id=57954c6f02182308d7000008
orderNumberstring

Sipariş Numarası

Example: orderNumber=123456
curl -i -X GET \
  'https://developers.vigo.ist/_mock/docs/order?id=57954c6f02182308d7000008&orderNumber=123456' \
  -H 'x-auth-token: YOUR_API_KEY_HERE'

Responses

Teslimat Bilgisi

Bodyapplication/json
pickupPointStateobject
orderStateobject
stepStatesArray of objects
courierLocationobject(Location)
serverTimestring(date-time)(ServerTime)

senkronizasyon amaçlı sunucu zamanı

Example: "2020-07-14T17:29:15.646Z"
Response
application/json

Bu şirket kuyruğu seçeneği etkin. Teslimatların kuyrukta olması için her zaman maksimum bir süre değeri vardır. Teslimat, bu süre aşıldıktan sonra kuyrukta olmayacaktır. Bu zaman değerini uygulama panelinden öğrenebilirsiniz. Bu teslimat, teslim alacak bir kurye bulunana kadar bir süre beklenecektir. Diğer bir ihtimal ise sürenin dolmasıdır. Note: Teslimatın her aşaması hakkında bilgilendirileceksiniz. Eğer bir callback url belirlediyseniz.

{
  "order": {
    "id": "627d0a69dc1f4a3d10ff5db5",
    "orderNumber": "12345",
    "state": "inQueue",
    "description": "",
    "tracking": { … },
    "assignedCourier": null
  },
  "serverTime": "2022-05-12T13:42:02.506Z"
}

Sipariş İptali

Request

Security
XAuthToken
Query
idstring

Sipariş Kimliği; bu parametre orderNumber parametresi ile birlikte gönderilmemelidir.

Example: id=57954c6f02182308d7000008
orderNumberstring

Sipariş Numarası; bu parametre id parametresi ile birlikte gönderilmemelidir.

Example: orderNumber=123456
cancelTextstring

İptal sebebi.

Example: cancelText=Siparişteki ürünler stokta kalmadı.
curl -i -X PUT \
  'https://developers.vigo.ist/_mock/docs/order/cancel?id=57954c6f02182308d7000008&orderNumber=123456&cancelText=Sipari%C5%9Fteki+%C3%BCr%C3%BCnler+stokta+kalmad%C4%B1.' \
  -H 'x-auth-token: YOUR_API_KEY_HERE'

Responses

Sipariş İptal Bilgisi

Bodyapplication/json
successboolean
Example: true
messagestring
Example: "Sipariş iptal edildi"
Response
application/json
{
  "success": true,
  "message": "Sipariş iptal edildi"
}

Sipariş Hazırlandı

Request

Security
XAuthToken
Query
idstring

Sipariş Kimliği. Bu parametre orderNumber parametresi ile birlikte gönderilmemelidir.

Example: id=57954c6f02182308d7000008
orderNumberstring

Sipariş Numarası. Bu parametre id parametresi ile birlikte gönderilmemelidir.

Example: orderNumber=123456
curl -i -X PUT \
  'https://developers.vigo.ist/_mock/docs/order/prepared?id=57954c6f02182308d7000008&orderNumber=123456' \
  -H 'x-auth-token: YOUR_API_KEY_HERE'

Responses

Sipariş Hazırlandı Bilgisi

Bodyapplication/json
successboolean
Example: true
messagestring
Example: "Sipariş hazırlandı"
Response
application/json
{
  "success": true,
  "message": "Sipariş hazırlandı"
}

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