Bu servis ile sipariş paketleriniz için webhook yapısı kurabilirsiniz.

  • Servis cevabı olarak dönen ID değeri kurmuş olduğunuz webhook yapısının ID değeridir, ve update, delete işlemlerinde kullanılması gerekmektedir.

  • Entegrasyon servislerine gönderilecek istekler, temel kimlik doğrulama yöntemi olan "basic authentication" ile yetkilendirilmelidir.

    • Basic Authentication için kullanılan sellerId, API KEY ve API SECRET KEY bilgileri satıcı panelinde yer alan "Hesap Bilgilerim" bölümündeki "Entegrasyon Bilgileri" sayfasından alınmalıdır.
  • Eğer servisiniz header'da api key bekliyorsa, ilgili alan "x-api-key" olarak gönderilecektir.

POST createWebhook

Giriş Parametreleri

DeğerAçıklamaTip
urlWebhook Servis URL Bilgisistring
usernameBasic Authentication için kullanılacak olan kullanıcı adıstring
passwordBasic Authentication için kullanılacak olan şifrestring
authenticationType"BASIC_AUTHENTICATION" ya da "API_KEY" değerini alabilirstring
apiKeyAuthorization için kullanılacak olan apikey bilgisistring
subscribedStatusesSipariş bilgisi alınması istenilen statu listesiarray

"subscribedStatuses" alanı için girebileceğiniz statüler aşağıdaki gibidir:

Eğer "subscribedStatuses" alanı boş bir şekilde gönderilirse aşağıda belirtilen bütün statuler otomatik olarak atanmaktadır. Aşağıda ki listeye yeni bir statu eklenmesi durumunda eklenen statu aynı şekilde mevcut başvurunuza tanımlanır.

  • "CREATED"
  • "PICKING"
  • "INVOICED"
  • "SHIPPED"
  • "CANCELLED"
  • "DELIVERED"
  • "UNDELIVERED"
  • "RETURNED"
  • "UNSUPPLIED"
  • "AWAITING"
  • "UNPACKED"
  • "AT_COLLECTION_POINT"
  • "VERIFIED"

Örnek Servis İsteği

{
    "url": "https://testwebhook.com",
    "username": "user",
    "password": "password",
    "authenticationType": "API_KEY",
    "apiKey": "123456",
    "subscribedStatuses": ["CREATED", "PICKING"]
 }

Örnek Servis Cevabı

{
  "id": "string"
}