Monist Delivery Modülü Servis Dokümantasyonu

Ülkeler Listesi

GET

Yanıt Parametreleri:

Parametre	Tipi	Örnek Değer	Açıklama
item_id	integer	1	Ülkenin tanımlı ID'si
name	string	"TÜRKİYE"	Ülkenin tanımlı adı
country_code	string	"tr"	Ülkenin uluslararası dil kodu
is_active	boolean	true	Ülkenin sistemdeki durumu

Şehirler Listesi

GET

Yanıt Parametreleri:

Parametre	Tipi	Örnek Değer	Açıklama
country_id	integer	1	Ülkenin tanımlı ID'si
item_id	integer	34	Şehirin tanımlı ID'si
name	string	"İSTANBUL"	Şehrin Adı
is_active	boolean	true	Şehrin sistemdeki durumu

İlçeler Listesi

GET

Yanıt Parametreleri:

Parametre	Tipi	Örnek Değer	Açıklama
city_id	integer	34	Şehrin tanımlı ID'si
item_id	integer	23	İlçenin tanımlı ID'si
name	string	"ATAŞEHİR"	İlçenin Adı
is_active	boolean	true	İlçenin sistemdeki durumu

Mahalleler Listesi

GET

İstek Parametreleri:

Parametre	Tipi	Zorunluluk	Örnek Değer	Açıklama
district_id	integer	zorunlu	23	Mahalle listesi istenen ilçenin ID'si

Yanıt Parametreleri:

Parametre	Tipi	Örnek Değer	Açıklama
district_id	integer	23	İlçenin tanımlı ID'si
item_id	integer	432	Mahallenin tanımlı ID'si
name	string	"BARBAROS"	Mahallenin Adı
city_id	integer	34	İlin tanımlı ID'si
is_active	boolean	true	Mahallenin sistemdeki durumu

Kargo Firmaları

GET

Yanıt Parametreleri:

Parametre	Tipi	Örnek Değer	Açıklama
item_id	integer	1	Tanımlı kargo şirketi ID'si
name	string	Yurtiçi Kargo	Kargo şirketi adı
slug	string	yurtici_kargo	Kargo şirketi sistem tanımı
is_active	boolean	true	Kargo şirketinin sistemdeki durumu
services	object	{...}	Kargo firmasının sunduğu hizmet tipleri

Gönderi Tipleri

GET

Yanıt Parametreleri:

Parametre	Tipi	Örnek Değer	Açıklama
item_id	integer	1	Hizmet ID'si
name	string	"Standart Gönderi"	Hizmetin adı
description	string	"Gönderi firmasının standart hizmet koşullarındaki gönderi tipi"	Hizmetin açıklaması
slug	string	"standart"	Hizmetin kısa tanımı

Depo Bilgileri

GET

Yanıt Parametreleri:

Parametre	Tipi	Örnek Değer	Açıklama
item_id	integer	23	Depo ID'si
name	string	"Merkez Depo"	Deponun adı
city_id	integer	34	Bulunduğu şehir ID'si
city_name	string	"İSTANBUL"	Bulunduğu şehir adı
address	string	"Şeyma Sk. No:23"	Adres bilgisi
pickup_point	bool	true	Toplama noktası mı?
return_point	bool	true	İade noktası mı?
is_active	bool	true	Aktif durumda mı?

Gönderi Durumu

GET

Oluşturmuş olduğunuz gönderinizin durumunu sorgulayabileceğiniz servis. İstek parametrelerinden en az birini göndermeniz zorunludur.

İstek Parametreleri:

Parametre	Tipi	Zorunlu	Örnek Değer	Açıklama
item_id	string	opsiyonel	a44742e5-fe30-4fe7-a742-a88e52cf5da4	Monist tarafından oluşturulmuş item_id(upid)
customer_tracking_nr	string	opsiyonel	2571868953012853P1	Sizin tarafınızdan oluşturulmuş kod
type	string	opsiyonel	return	İade gönderisinin durumu sorgulanmak istendiğinde

Gönderi Oluştur

POST

Sisteminize gelen siparişin paketleri için kargo etiketi alabilmenizi sağlayan servistir.

İstek Parametreleri:

Parametre	Tipi	Zorunlu	Açıklama
account_id	integer	zorunlu	Firmanızın Monist sistemindeki kayıtlı Hesap ID'si
price_list	string	zorunlu	"OPL" kendi hesaplarınız, "MPL" Monist fiyatları için
order_nr	string	zorunlu	Sisteminizdeki siparişin takip numarası
package_nr	string	zorunlu	Paket numarası
warehouse_id	integer	zorunlu	Monist üzerinde kayıtlı depo ID'niz
delivery_type	integer	zorunlu	Monist üzerinde kayıtlı gönderi tipinin ID'si
recipient_name	string	zorunlu	Alıcı adı
recipient_surname	string	zorunlu	Alıcı soyadı
recipient_phone	integer	zorunlu	Alıcı telefon numarası (başında sıfır olmadan)
recipient_email	string	zorunlu	Alıcı e-mail adresi
shipment_items	array	zorunlu	Paket içerisindeki ürünlerin ayrıntıları

Örnek İstek:

{
  "account_id": 23,
  "price_list": "OPL",
  "order_nr": "2571868953012853",
  "order_date": "2024-04-06T16:08:00+03:00",
  "package_nr": "2571868953012853P1",
  "customer_tracking_nr": "2571868953012853P1",
  "warehouse_id": 1,
  "delivery_type": 1,
  "recipient_name": "Melda",
  "recipient_surname": "Tınkır",
  "recipient_phone": "5549448498",
  "recipient_email": "meldatinkir@gmail.com",
  "recipient_country": 1,
  "recipient_city": 50,
  "recipient_district": 228,
  "recipient_neighbourhood": 69146,
  "recipient_address": "Yenişehir mah ibrahim sur sk",
  "item_count": 2,
  "shipment_items": [
    {
      "item_name": "Kazak",
      "item_code": "82348923",
      "item_description": "Yün erkek kazak - Siyah"
    }
  ]
}

Gönderi Güncelle

PATCH

Oluşturmuş olduğunuz gönderinizin desi ve gönderi içindeki ürün adetlerini güncelleyebileceğiniz istek yöntemidir.

Gönderi İptal

POST

Daha önceden oluşturmuş olduğunuz gönderinin herhangi bir nedenle iptal edilmesini sağlayan istektir.

Gönderi Etiketi

GET

Daha önceden oluşturmuş olduğunuz gönderinin etiketini almak istediğinizde kullanabileceğiniz servistir.

Giden Gönderi Takip Linki

GET

Gönderinin taşıyıcı tarafındaki durumuna göre takip sayfasına yönlendirir.

RMA İade Talebi Oluştur

POST

İade gönderisi için ortak iade talebi servisidir. Servise ilgili istek gönderildikten sonra gelen yanıt içerisinde iade gönderisinin taşıyıcı ve RMA kodu bilgileri yer almaktadır.

Örnek Yanıt:

{
  "item_id": "24ebcd32-4905-4080-85a3-0fa4e7d7565a",
  "monist_rma": "27453486465889861824",
  "supplier_slug": "yurtici_kargo",
  "status": "RMA Created"
}