Narwoo API Dökümantasyonu


Narwoo API Nedir, Ne İşe Yarar?

Narwoo.com'a üye olan ve satış yapmak isteyen bir kullanıcı, Narwoo API'yi kullanarak sisteme ürün ekleme, ürün güncelleme(stok,fiyat,fotoğraf vb.), siparişleri görme, siparişi onaylama, kargo takip numarası girme, kargo entegrasyonunu kullanma gibi bir çok özellikleri kendi sisteminde kullanabilir.

API Güvenliği

Narwoo API ‘ye yapılacak bütün isteklerde token kontrolü yapılmaktadır. Gönderilecek her istek de API'yi kullanabilme yetkisinin olup olmadığını anlamamız için token gönderilmesi zorunludur.

Versiyon Yenilikleri

Ürün ekleme ve düzenleme yaparken API'ye gönderilen parametreler arasına barcode ve sku parametreleri eklendi.

Ürün ekleme ve düzenleme yaparken API'ye gönderilen özellikler ve özellik değerleri için ID bilgisi göndermek yerine özellik adı ve özellik değeri adı gönderilmesine yönelik API yapısı değiştirildi.

Ürün ekleme ve düzenleme yaparken API'ye gönderilen marka bilgisi için ID göndermek yerine marka adı gönderilmesine yönelik API yapısı değiştirildi.

Ürün ekleme, düzenleme yaparken ve kargo oluştururken API'ye gönderilen kargo firma bilgisi için ID göndermek yerine kargo firmasının adının gönderilmesine yönelik API yapısı değiştirildi.

Ürünleri ve gelen siparişleri listelerken API'ye gönderilmesi gereken parametreler arasına offset ve limit parametreleri de eklendi.

Narwoo Logo

Gelen Siparişler


Satıcının gelen siparişlerini listeleyin.

Method: GET
URL: https://www.narwoo.com/api/order-list
Gerekli Parametreler: token, offset, limit, start_date, end_date

offset: varsayılan 0'dır. Dönen değerler üzerinden saymaya başlar.

limit: varsayılan 20'dir. En fazla 100 olabilir.

start_date: Tarih formatı olmalıdır. Varsayılan değer "istek atılan tarihten 3 ay öncesidir". Gönderilmesi gereken örnek değer: "2021-01-01 15:35".

end_date: Tarih formatı olmalıdır. Varsayılan değer "istek atılan tarihtir". Gönderilmesi gereken örnek değer: "2021-01-01 15:35".

Yukarıdaki parametrelerin hiçbiri gönderilmediği takdirde sadece token parametresi gönderilmiş ise son 3 aylık siparişlerin listesi görüntülenmektedir.
(Gönderilen her istek başına en fazla 100 adet veri gösterilir.)


Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"order_list": [
    {
        "order_number": "123456789123",
        "order_price": "25.00",
        "order_currency": "TRY",
        "order_date": "2020-08-28 14:24:46",
        "order_payment_status": "2"
    }
]
  • order_number (string): sipariş numarası
  • order_price (string): siparişin toplam tutarı
  • order_currency (string): siparişin toplam tutarının para birimi
  • order_date (datetime): siparişin oluşturulma tarihi
  • order_payment_status (integer): alıcının sipariş ücretini ödeme durumu
    • 0 dönerse ödenmemiş.
    • 1 dönerse bir hata oluştu.
    • 2 dönerse ödenmiş.

API'ye Giriş Yap (Login)


API'ye giriş yaparak token oluşmasını sağlayın.

Method: GET
URL: https://www.narwoo.com/api/login
Gerekli Parametreler: userEmail, userPassword

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
    "errCode": 0,
    "token": 2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e730,
},
"error": 0
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.
  • token (string): oturumun başarıyla açılması sonucunda yapacağınız her işlemde API'ye göndermeniz gereken uzun şifre

Kategorileri Listele


Tüm kategorileri listeleyin.

Method: GET
URL: https://www.narwoo.com/api/category-list
Gerekli Parametreler: token

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
        "optionList": {
            "249": {
                "id": "249",
                "parent_id": "0",
                "name": "Din ve Törenler",
                "sub": {
                    "250": {
                        "id": "250",
                        "parent_id": "249",
                        "name": "Anma Töreni Malzemeleri",
                        "sub": {
                            "251": {
                                "id": "251",
                                "parent_id": "250",
                                "name": "Kül Saklama Küpleri",
                                "sub": []
                            }
                        }
                    },
                    "252": {
                        "id": "252",
                        "parent_id": "249",
                        "name": "Dini Eşyalar",
                        "sub": {
                            "253": {
                                "id": "253",
                                "parent_id": "252",
                                "name": "Başörtüleri",
                                "sub": []
                            },
                            "254": {
                                "id": "254",
                                "parent_id": "252",
                                "name": "Dini Sunaklar",
                                "sub": []
                            },
                         }
                    }
               
                }
                
            }
            
         }
     "errCode": 0       
    }
"error": 0
  • id (integer): Kategorinin ID bilgisi
  • parent_id (integer): Kategorinin bağlı olduğu bir üst kategorinin ID bilgisi
  • name (string): Kategorinin adı
  • sub (array): İlgili kategoriye ait alt kategorilerin bilgisi
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.

Özellikleri Listele


İlgili kategorideki tüm özellikleri detaylarıyla listeleyin.

Method: GET
URL: https://www.narwoo.com/api/option-list
Gerekli Parametreler: token, categoryId

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
    "optionList": {
       "180": {
            "id": "180",
            "name": "Renk",
            "variantStatus": true,
            "values": {
                "3287": {
                    "id": "3287",
                    "name": "Karışık"
                },
                "3289": {
                    "id": "3289",
                    "name": "Beyaz"
                },
                "3291": {
                    "id": "3291",
                    "name": "Sarı"
                },
                "3293": {
                    "id": "3293",
                    "name": "Altın"
                },
                "3295": {
                    "id": "3295",
                    "name": "Gümüş"
                },
                "3297": {
                    "id": "3297",
                    "name": "Pembe"
                },
                "3299": {
                    "id": "3299",
                    "name": "Mavi"
                },
                "3301": {
                    "id": "3301",
                    "name": "Siyah"
                }
            }
        },
        "176": {
            "id": "176",
            "name": "Dahili Hafıza",
            "variantStatus": false,
            "values": {
                "3227": {
                    "id": "3227",
                    "name": "4 GB"
                },
                "3229": {
                    "id": "3229",
                    "name": "8 GB"
                },
                "3231": {
                    "id": "3231",
                    "name": "16 GB"
                },
                "3233": {
                    "id": "3233",
                    "name": "32 GB"
                },
                "3235": {
                    "id": "3235",
                    "name": "64 GB"
                }
            }
        }
   }
  "errCode": 0
    },
    "error": 0
  • id (integer): Özelliğin veya özellik değerinin ID bilgisi
  • name (string): Özelliğin veya özellik değerinin adı
  • variantStatus (string): Özelliğin varyant özelliği olup olmamasının bilgisi
    • true Özellik, aynı zamanda varyant özelliğidir.
    • false Özellik, varyant özelliği değildir.
  • values (array): İlgili özelliğe ait değerlerin bilgisi
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.

Ürün Sil


Narwoo'da bulunan ürününüzü silin

Method: GET
URL: https://www.narwoo.com/api/delete-product
Gerekli Parametreler: token, productId

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
        "status": "deleted",
        "errCode": 0,
    },
    "error": 0
  • status (string): Ürünün silinip silinmediğine dair durum bilgisi
    • deleted Ürünün başarıyla silindi.
    • error Ürün silinirken bir hata oluştu.
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.

Markaları Listele


İlgili kategorideki markaları listeleyin.

Method: GET
URL: https://www.narwoo.com/api/brand-list
Gerekli Parametreler: token, categoryId

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
 "o": {
   "brandList": [
        {
            "id": "103",
            "name": "Cat"
        },
        {
            "id": "297",
            "name": "Motorola"
        },
        {
            "id": "311",
            "name": "Odisu"
        },
        {
            "id": "315",
            "name": "Zte"
        },
        {
            "id": "380",
            "name": "Philips"
        },
        {
            "id": "1203",
            "name": "Yota"
        },
        {
            "id": "1204",
            "name": "Zopo"
        }
    ]
       "errCode": 0
      },
    "error": 0
  • id (integer): Markanın ID bilgisi
  • name (string): Markanın adı
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.

Ürünleri Listele


Narwoo'da bulunan ürünlerinizi listeleyin.

Method: GET
URL: https://www.narwoo.com/api/product-list
Gerekli Parametreler: token, offset, limit, type, sku

offset: varsayılan 0'dır. Dönen değerler üzerinden saymaya başlar.

limit: varsayılan 20'dir. En fazla 100 olabilir.

type: varsayılan değer byUser dır. bySku olarak gönderilmesi durumunda sku ya göre listeleme yapar.

sku: byUser tipinde listeleme isteniyorsa bu değer boş gönderilmesi gerekir, bySku tipinde listeleme yapılacaksa ilgili sku değerinin gönderilmesi gerekir.


Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
        "productList": [
            {
                "productId": "3185",
                "categoryId": "2477",
                "title": "Erkek Pamkuklu Kazak",
                "sku": "ZR76-siyah-xl",
                "barcode": "ABC474639",
                "price": "180.00",
                "currency": "1",
                "stock": "35",
                "brandName": "Zara",
                "cargoOption": "0",
                "status": "active",
                "attributes": [
                    {
                        "attributeName": "Kumaş Cinsi",
                        "attributeValue": "Pamuklu"
                    },
                    {
                        "attributeName": "Renk",
                        "attributeValue": "beyaz"
                    },
                    {
                        "attributeName": "Beden",
                        "attributeValue": "s"
                    }
                ],
                "variants": [
                    {
                        "sku": "-Kahverengi-s",
                        "barcode": "ABC474643",
                        "price": "219.99",
                        "stock": "12",
                        "attributes": [
                            {
                                "attributeName": "Renk",
                                "attributeValue": "kahverengi"
                            },
                            {
                                "attributeName": "Beden",
                                "attributeValue": "s"
                            }
                        ]
                    },
                    {
                        "sku": "-Kahverengi-l",
                        "barcode": "ABC474544",
                        "price": "164.00",
                        "stock": "10",
                        "attributes": [
                            {
                                "attributeName": "Renk",
                                "attributeValue": "kahverengi"
                            },
                            {
                                "attributeName": "Beden",
                                "attributeValue": "l"
                            }
                        ]
                    },
                    {
                        "sku": "-Gri-s",
                        "barcode": "ABC472554",
                        "price": "189.00",
                        "stock": "8",
                        "attributes": [
                            {
                                "attributeName": "Renk",
                                "attributeValue": "gri"
                            },
                            {
                                "attributeName": "Beden",
                                "attributeValue": "s"
                            }
                        ]
                    },
                    {
                        "sku": "-Gri-l",
                        "barcode": "ABC474698",
                        "price": "224.50",
                        "stock": "5",
                        "attributes": [
                            {
                                "attributeName": "Renk",
                                "attributeValue": "gri"
                            },
                            {
                                "attributeName": "Beden",
                                "attributeValue": "l"
                            }
                        ]
                    }
                ]
            },
             {
                "productId": "219",
                "categoryId": "262",
                "title": "Iphone 11 Pro Max",
                "sku": "AP76-128",
                "barcode": "ABC475454",
                "price": "12999.00",
                "currency": "1",
                "stock": "20",
                "brandName": "Apple",
                "cargoOption": "1",
                "cargoCompanyName": "UPS",
                "cargoPrice": "29.90",
                "status": "pending",
                "attributes": [
                    {
                        "attributeName": "Hafıza",
                        "attributeValue": "128 GB"
                    }
                ]
            }
        ]
    }
"error": 0
  • productId (integer): Ürünün Narwoo'daki ID bilgisi
  • title (string): Ürün başlığı
  • brandName (integer): Ürün markasının adı
  • categoryId (integer): Ürün kategorisinin ID bilgisi
  • stock (integer): Ürünün stok sayısı
  • sku (string): Stok kodu bilgisi
  • barcode (string): Barkod bilgisi
  • currency (integer): Ürünün satış para birimi
    • 1 Türk Lirası (TRY)
    • 2 Amerikan Dolar (USD)
    • 3 Euro (EUR)
    • 4 İngiliz Sterlini (GBP)
    • 5 Japon Yeni (JPY)
  • price (float): Ürünün satış fiyatı
  • status (string): Ürünün yayın durumunu gösterir
    • active Aktif
    • passive Pasif
    • pending Onay bekliyor
    • denied Reddedildi
    • expired Süresi doldu
  • cargoOption (integer): Kargo ücretinin kim tarafından ödeneceği bilgisi
    • 0 Satıcı Ödemeli
    • 1 Alıcı Ödemeli
  • cargoCompanyName (string): Kargo firmasının adı (cargoOption parametresi 1 ise bu değer döner.)
  • cargoPrice (string): Kargo fiyatı (cargoOption parametresi 1 ise bu değer döner.)
  • attributes (array): Ürünün özellikleri
  • attributeName (integer): Özelliğin adı
  • attributeValue (string): Özellik değerinin adı

Ürün Ekle


Varyantlı veya varyantsız ürünlerinizi ekleyin.

Method: POST
URL: https://www.narwoo.com/api/add-product
Gerekli Parametreler: productList Veri Türü: JSON

Örnek "productList" parametresi (Varyantsız):

 "o": [
        {
            "title": "Kadın Beli Lastikli Duble Paça Kumuş Pantolon",
            "type": "mainProduct",
            "brandName": "Zara",
            "categoryId": "2477",
            "quantity": "50",
            "sku": "ZR98-mavi-s",
            "barcode": "ABC6743948",
            "description": "Ürün açıklama bilgisi",
            "currency": "1",
            "price": "129.99",
            "salePrice": "79.99",
            "cargoOption": "1",
            "minSaleQuantity": "1",
            "maxCargoTime": "1",
            "cargoCompanyName": "Aras Kargo",
            "cargoPrice": "9.99",
            "maxProductQuantityForCargoPrice": "1",
            "images": {
                  {
                    "url": "https://www.youradress/path/folder/image_1.jpg",
                    "prime": "1"
                  },
                  {
                    "url": "https://www.youradress/path/folder/image_2.jpg",
                    "prime": "0"
                  },
                  {
                    "url": "https://www.youradress/path/folder/image_2.jpg",
                    "prime": "0"
                 },
            }
            "attributes": {
                  {
                    "attributeName": "Renk",
                    "attributeValue": "Mavi",
                    "attributeType" : "1"
                  },
                  {
                    "attributeName": "Beden",
                    "attributeValue": "S",
                    "attributeType" : "1"
                  }
            } 
        },
    ],
    "error": 0

Örnek "productList" parametresi (Varyantlı):

 "o": [
        {
            "title": "Kadın Beli Lastikli Duble Paça Kumuş Pantolon",
            "type": "mainProduct",
            "brandName": "Zara",
            "categoryId": "2477",
            "quantity": "50",
            "sku": "ZR98-mavi-s",
            "barcode": "ABC6743948",
            "description": "Ürün açıklama bilgisi",
            "currency": "1",
            "price": "129.99",
            "salePrice": "79.99",
            "cargoOption": "1",
            "minSaleQuantity": "1",
            "maxCargoTime": "1",
            "cargoCompanyName": "Aras Kargo",
            "cargoPrice": "9.99",
            "maxProductQuantityForCargoPrice": "1",
            "images": {
                  {
                    "url": "https://www.youradress/path/folder/image_1.jpg",
                    "prime": "1"
                  },
                  {
                    "url": "https://www.youradress/path/folder/image_2.jpg",
                    "prime": "0"
                  },
                  {
                    "url": "https://www.youradress/path/folder/image_2.jpg",
                    "prime": "0"
                 },
            }
            "attributes": {
                  {
                    "attributeName": "Renk",
                    "attributeValue": "Kırmızı",
                    "attributeType" : "1"
                  },
                  {
                    "attributeName": "Beden",
                    "attributeValue": "L",
                    "attributeType" : "1"
                  }
            } 
        },
        
     {
            "type": "variant",
            "quantity": "10",
            "sku": "-lacivert-XXL",
            "barcode": "ABC674343",
            "price": "89.99",
            "image": "https://www.youradress/path/folder/image_3.jpg",
            "attributes": {
                  {
                    "attributeName": "Renk",
                    "attributeValue": "Lacivert"
                  },
                  {
                    "attributeName": "Beden",
                    "attributeValue": "XXL"
                  }
            } 
        },    
        
       {
            "type": "variant",
            "quantity": "8",
            "sku": "-bej-XL",
            "barcode": "ABC6743322",
            "price": "109.99",
            "image": "https://www.youradress/path/folder/image_4.jpg",
            "attributes": {
                  {
                    "attributeName": "Renk",
                    "attributeValue": "Bej"
                  },
                  {
                    "attributeName": "Beden",
                    "attributeValue": "XL"
                  }
            } 
        },        
        
    ],
    "error": 0
  • title (string): Ürün başlığı
  • type (string): Ürün tipi
    • mainProduct Ana Ürün
    • variant Varyant Ürün
  • brandName (integer): Ürün markasının adı
  • categoryId (integer): Ürün kategorisinin ID bilgisi
  • quantity (integer): Ürünün stok sayısı
  • sku (string): Stok kodu bilgisi
  • barcode (string): Barkod bilgisi
  • description (string): Ürün açıklaması
  • currency (integer): Ürünün satış para birimi
    • 1 Türk Lirası (TRY)
    • 2 Amerikan Dolar (USD)
    • 3 Euro (EUR)
    • 4 İngiliz Sterlini (GBP)
    • 5 Japon Yeni (JPY)
  • price (float): Ürünün satış fiyatı (Kuruş ayrımı için nokta(.) kullanınız. Örn: 2756.89)
  • salePrice (float): Ürünün indirimli satış fiyatı (Kuruş ayrımı için nokta(.) kullanınız. Örn: 1935.00)
  • cargoOption (integer): Kargo ücretinin kim tarafından ödeneceği bilgisi
    • 0 Satıcı Ödemeli
    • 1 Alıcı Ödemeli
  • minSaleQuantity (integer): Satın alınabilecek minimum ürün adedi
  • maxCargoTime (integer): Ürünü kargoya verme süresi
    • 0 Aynı gün
    • 1 1 gün
    • 2 2 gün
    • 3 3 gün
    • 4 4 gün
    • .
    • .
    • .
  • cargoCompanyName (integer): Kargo firmasının adı (Ürün satıcı ödemeliyse değer boş gönderilmelidir.)
  • cargoPrice (float): Kargo fiyatı (Ürün satıcı ödemeliyse değer 0 olmalıdır. Kuruş ayrımı için nokta(.) kullanınız. Örn: 15.00)
  • maxProductQuantityForCargoPrice (integer): Belirtilen kargo ücreti ile gönderilebilecek max. ürün adedi
  • images (array): Ürüne ait fotoğraflar
  • url (string): Fotoğrafın linki
  • prime (integer): Fotoğrafın öne çıkarılmış fotoğraf olup olmadığı bilgisi (Fotoğraflar arasından sadece bir fotoğrafın prime değeri 1, diğerlerinin 0 olmalıdır.)
    • 0 Öne çıkarılmış fotoğraf değil
    • 1 Öne çıkarılmış fotoğraf
  • attributes (array): Ürünün özellikleri
  • attributeName (integer): Özelliğin adı
  • attributeValue (string): Özellik değerinin adı
  • attributeType (integer): Özelliğin varyant özelliği olabilirliği
    • 0 Bu özellik varyant özelliği olamaz (Örn: Çözünürlük, İşletim Sitemi vs.)
    • 1 Bu özellik varyant özelliği olabilir (Örn: Renk, Beden vs.)
  • image (string): Varyantın fotoğraf linki

Dönen Değerler

Veri Türü: JSON
Çıktı örneği aşağıdaki gibidir:
"o": {
        "status": "success",
        "errList": []
    },
    "error": 0
  • status (string): Ürünün kaydedilme durumu
    • success Ürün başarıyla kaydedildi
    • error Ürün kaydedilirken hata oluştu
  • errList (array): Kaydedilme sırasında oluşan hataların listesi

Ürün Düzenle


Narwoo'da bulunan ürünlerinizi düzenleyin.

Method: POST
URL: https://www.narwoo.com/api/edit-product
Gerekli Parametreler: productList Veri Türü: JSON

Örnek "productList" parametresi (Varyantsız):

 "o": [
        {
            "productId": "123",
            "title": "Kadın Beli Lastikli Duble Paça Kumuş Pantolon",
            "type": "mainProduct",
            "brandName": "Zara",
            "categoryId": "2477",
            "quantity": "50",
            "sku": "ZR98-mavi-s",
            "barcode": "ABC6743948",
            "description": "Ürün açıklama bilgisi",
            "currency": "1",
            "price": "129.99",
            "salePrice": "79.99",
            "cargoOption": "1",
            "minSaleQuantity": "1",
            "maxCargoTime": "1",
            "cargoCompanyName": "Aras Kargo",
            "cargoPrice": "9.99",
            "maxProductQuantityForCargoPrice": "1",
            "images": {
                  {
                    "url": "https://www.youradress/path/folder/image_1.jpg",
                    "prime": "1"
                  },
                  {
                    "url": "https://www.youradress/path/folder/image_2.jpg",
                    "prime": "0"
                  },
                  {
                    "url": "https://www.youradress/path/folder/image_2.jpg",
                    "prime": "0"
                 },
            }
             "attributes": {
                  {
                    "attributeName": "Renk",
                    "attributeValue": "Kırmızı",
                    "attributeType" : "1"
                  },
                  {
                    "attributeName": "Beden",
                    "attributeValue": "L",
                    "attributeType" : "1"
                  }
            } 
        },
    ],
    "error": 0

Örnek "productList" parametresi (Varyantlı):

 "o": [
        {
            "productId": "123",
            "title": "Kadın Beli Lastikli Duble Paça Kumuş Pantolon",
            "type": "mainProduct",
            "brandName": "Zara",
            "categoryId": "2477",
            "quantity": "50",
            "sku": "ZR98-mavi-s",
            "barcode": "ABC6743948",
            "description": "Ürün açıklama bilgisi",
            "currency": "1",
            "price": "129.99",
            "salePrice": "79.99",
            "cargoOption": "1",
            "minSaleQuantity": "1",
            "maxCargoTime": "1",
            "cargoCompanyName": "Aras Kargo",
            "cargoPrice": "9.99",
            "maxProductQuantityForCargoPrice": "1",
            "images": {
                  {
                    "url": "https://www.youradress/path/folder/image_1.jpg",
                    "prime": "1"
                  },
                  {
                    "url": "https://www.youradress/path/folder/image_2.jpg",
                    "prime": "0"
                  },
                  {
                    "url": "https://www.youradress/path/folder/image_2.jpg",
                    "prime": "0"
                 },
            }
            "attributes": {
                  {
                    "attributeName": "Renk",
                    "attributeValue": "Mavi",
                    "attributeType" : "1"
                  },
                  {
                    "attributeName": "Beden",
                    "attributeValue": "S",
                    "attributeType" : "1"
                  }
            } 
        },
        
    {
            "type": "variant",
            "quantity": "10",
            "sku": "-lacivert-XXL",
            "barcode": "ABC6743989",
            "price": "89.99",
            "image": "https://www.youradress/path/folder/image_3.jpg",
            "attributes": {
                  {
                    "attributeName": "Renk",
                    "attributeValue": "Lacivert"
                  },
                  {
                    "attributeName": "Beden",
                    "attributeValue": "XXL"
                  }
            }
        },

       {
            "type": "variant",
            "quantity": "8",
            "sku": "-bej-XL",
            "barcode": "ABC6743955",
            "price": "109.99",
            "image": "https://www.youradress/path/folder/image_4.jpg",
            "attributes": {
                  {
                    "attributeName": "Renk",
                    "attributeValue": "Bej"
                  },
                  {
                    "attributeName": "Beden",
                    "attributeValue": "XL"
                  }
            }
        },
        
    ],
    "error": 0
  • productId (string): Düzenlenen ürünün Narwoo'daki ID bilgisi
  • title (string): Ürün başlığı
  • type (string): Ürün tipi
    • mainProduct Ana Ürün
    • variant Varyant Ürün
  • brandName (integer): Ürün markasının adı
  • categoryId (integer): Ürün kategorisinin ID bilgisi
  • quantity (integer): Ürünün stok sayısı
  • sku (string): Stok kodu bilgisi
  • barcode (string): Barkod bilgisi
  • description (string): Ürün açıklaması
  • currency (integer): Ürünün satış para birimi
    • 1 Türk Lirası (TRY)
    • 2 Amerikan Dolar (USD)
    • 3 Euro (EUR)
    • 4 İngiliz Sterlini (GBP)
    • 5 Japon Yeni (JPY)
  • price (float): Ürünün satış fiyatı (Kuruş ayrımı için nokta(.) kullanınız. Örn: 2756.89)
  • salePrice (float): Ürünün indirimli satış fiyatı (Kuruş ayrımı için nokta(.) kullanınız. Örn: 1935.00)
  • cargoOption (integer): Kargo ücretinin kim tarafından ödeneceği bilgisi
    • 0 Satıcı Ödemeli
    • 1 Alıcı Ödemeli
  • minSaleQuantity (integer): Satın alınabilecek minimum ürün adedi
  • maxCargoTime (integer): Ürünü kargoya verme süresi
    • 0 Aynı gün
    • 1 1 gün
    • 2 2 gün
    • 3 3 gün
    • 4 4 gün
    • .
    • .
    • .
  • cargoCompanyName (integer): Kargo firmasının adı (Ürün satıcı ödemeliyse değer boş gönderilmelidir.)
  • cargoPrice (float): Kargo fiyatı (Ürün satıcı ödemeliyse değer 0 olmalıdır. Kuruş ayrımı için nokta(.) kullanınız. Örn: 15.00)
  • maxProductQuantityForCargoPrice (integer): Belirtilen kargo ücreti ile gönderilebilecek max. ürün adedi
  • images (array): Ürüne ait fotoğraflar
  • url (string): Fotoğrafın linki
  • prime (integer): Fotoğrafın öne çıkarılmış fotoğraf olup olmadığı bilgisi (Fotoğraflar arasından sadece bir fotoğrafın prime değeri 1, diğerlerinin 0 olmalıdır.)
    • 0 Öne çıkarılmış fotoğraf değil
    • 1 Öne çıkarılmış fotoğraf
  • attributes (array): Ürünün özellikleri
  • attributeName (integer): Özelliğin adı
  • attributeValue (string): Özellik değerinin adı
  • attributeType (integer): Özelliğin varyant özelliği olabilirliği
    • 0 Bu özellik varyant özelliği olamaz (Örn: Çözünürlük, İşletim Sitemi vs.)
    • 1 Bu özellik varyant özelliği olabilir (Örn: Renk, Beden vs.)
  • image (string): Varyantın fotoğraf linki

Dönen Değerler

Veri Türü: JSON
Çıktı örneği aşağıdaki gibidir:
"o": {
        "status": "success",
        "errList": []
    },
    "error": 0
  • status (string): Ürünün düzenlenme durumu
    • success Ürün başarıyla düzenlendi
    • error Ürün düzenlenirken hata oluştu
  • errList (array): Düzenlenme sırasında oluşan hataların listesi

Sipariş Detayı


Gelen bir siparişin detaylarını inceleyin.

Method: GET
URL: https://www.narwoo.com/api/order-detail
Gerekli Parametreler: token, order_number

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"order_number": "123456789123",
"order_total_price": "25.00",
"order_currency": "TRY",
"order_date": "2020-08-28 14:24:46",
"order_payment_type": "0",
"order_payment_status": "2",
"order_canceled": "0",
"customer": {
    "name": "Ad",
    "surname": "Soyad"
    "email": "[email protected]"
},
"order_addresses": {
    "invoice": {
        "invoice_recipient_name": "Ad",
        "invoice_recipient_surname": "Soyad",
        "invoice_country": "Turkey",
        "invoice_zone": "İstanbul",
        "invoice_town": "Üsküdar",
        "invoice_address": "Örnek Mahallesi. Örnek Caddesi. Örnek NO: 14.",
        "invoice_zipcode": "34000"
    },
    "delivery": {
        "delivery_recipient_name": "Ad",
        "delivery_recipient_surname": "Soyad",
        "delivery_country": "Turkey",
        "delivery_zone": "İstanbul",
        "delivery_town": "Üsküdar",
        "delivery_address": "Örnek Mahallesi. Örnek Caddesi. Örnek NO: 14.",
        "delivery_zipcode": "34000"
    }
},
"order_products": [
    {
        "product_name": "ERSL01 - Eğitim Yazılım Seti",
        "product_link": "https://www.narwoo.com/detail/ersl01-egitim-yazilim-seti-3211",
        "product_image_link": "https://www.narwoo.com/imgbuffer?src=/uploads/product/3211-ersl01-egitim-yazilim-seti-3211-9e1ef668aa.png&w=80&h=60",
        "product_category": "Eğitim Yazılımları",
        "product_barcode": "",
        "product_code": "",
        "product_quantity": "1",
        "product_single_price": "20,00",
        "product_single_old_price": "0.00",
        "product_cargo_price": "3,00",
        "product_total_price": "23,00",
        "product_currency_symbol": "₺",
        "product_stock": "835",
        "product_cargo_option": "1",
        "product_sku": "",
        "product_selected_variant": {
            "variant_name": null,
            "variant_price": null,
            "variant_stock": null,
            "variant_type": null,
            "variant_sku": null,
            "variant_barcode": null,
            "variant_option_list": [
                null
            ]
        }
    }
]
  • order_number (string): sipariş numarası
  • order_total_price (string): siparişin toplam tutarı
  • order_currency (string): siparişin toplam tutarının para birimi
  • order_date (datetime): siparişin oluşturulma tarihi
  • order_payment_type (integer): siparişin ödeme tipi
    • 0 EFT/Havale
    • 1 Kredi Kartı
  • order_payment_status (integer): alıcının sipariş ücretini ödeme durumu
    • 0 ödenmemiş.
    • 1 bir hata oluştu.
    • 2 ödenmiş.
  • order_canceled (integer): sipariş iptal durumu
    • 0 sipariş aktif.
    • 1 sipariş iptal edilmiş.
  • order_products (array): siparişteki ürünlerin listesi
    • product_name (string): ürün adı
    • product_link (string): ürünün narwoo.comdaki linki
    • product_image_link (string): ürünün vitrin resmi
    • product_category (string): ürün kategorisi
    • product_barcode (string): ürün barcodu
    • product_code (string): ürün kodu
    • product_quantity (integer): ürün adeti
    • product_single_price (string): 1 ürün adetinin fiyatı
    • product_single_old_price (string): 1 ürün adetinin eski fiyatı
    • product_cargo_price (string): ürünün kargo fiyatı
    • product_total_price (string): ürünün kendi fiyatı ve kargo fiyatının toplanmış fiyatı
    • product_currency_symbol (string): ürün fiyatının para birimi sembolü
    • product_stock (integer): ürün stok sayısı
    • product_cargo_option (integer): Alıcı veya Satıcı ödemeli seçeneği
      • 0 Satıcı ödemeli gönderi
      • 1 Alıcı ödemeli gönderi
    • product_sku (string): ürün sku bilgisi
    • product_selected_variant (array): Ürünün satın alınmış varyasyon bilgileri
      • variant_name (string): Varyasyon adı
      • variant_price (string): Varyasyon fiyatı
      • variant_stock (string): Varyasyon stok sayısı
      • variant_type (string): Varyasyon tipi
      • variant_sku (string): Varyasyon sku bilgisi
      • variant_barcode (string): Varyasyon barcode bilgisi
      • variant_option_list (array): Varyasyon seçenek listesi

Siparişi Onayla


Satıcının gelen siparişini onaylayın.

Method: POST
URL: https://www.narwoo.com/api/order-confirm
Gerekli Parametreler: token, order_number

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
    "errCode": 0,
    "message": "İşlem Başarılı"
},
"error": 0
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.
  • message (string): işlem durum mesajı

Sipariş İptal


Satıcının gelen siparişini iptal edin.

Method: POST
URL: https://www.narwoo.com/api/order-cancel
Gerekli Parametreler: token, order_number, cancel_reason

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
    "errCode": 0,
    "message": "İşlem Başarılı"
},
"error": 0
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.
  • message (string): işlem durum mesajı

Kargo Şirketleri


Sistemdeki kargo şirketlerinin listesini görüntüleyin. Bu liste kargo entegrasyon fonksiyonlarının bazılarında gerekli olabilir.

Method: GET
URL: https://www.narwoo.com/api/cargo-company-list
Gerekli Parametreler: token

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"cargo_companies_list": [
    {
        "cargo_id": "1",
        "cargo_name": "Aras Kargo"
    },
]
  • cargo_companies_list (array): Kargo şirketlerinin listesi
    • cargo_id (integer): Kargo firmasının ID'si
    • cargo_name (string): Kargo firmasının adı

Kargo Oluştur (Manuel)


Method: POST
URL: https://www.narwoo.com/api/cargo-create/manuel
Gerekli Parametreler: token, order_number, cargoCompanyName, cargo_number

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
    "errCode": 0,
    "message": "İşlem Başarılı"
},
"error": 0
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.
  • message (string): işlem durum mesajı

Kargo İptal (Manuel)


Sisteme kaydettiğiniz kargo takip kodunu kaldırın.

Method: POST
URL: https://www.narwoo.com/api/cargo-cancel/manuel
Gerekli Parametreler: token, order_number

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
    "errCode": 0,
    "message": "İşlem Başarılı"
},
"error": 0
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.
  • message (string): işlem durum mesajı

Kargo Oluştur (Entegrasyon)


Narwoo.com'un anlaşmalı olduğu kargo firmalarıyla kargonuzu gönderin.

Sistemimiz şimdilik sadece UPS kargo firmasını desteklenmektedir.

Method: POST
URL: https://www.narwoo.com/api/cargo-create/integration
Gerekli Parametreler: token, order_number

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
    "errCode": 0,
    "message": "İşlem Başarılı",
    "cargoKey": "1Z964AX56800000666",
    "cargoLabelLink": "http://ws.ups.com.tr/UmoWSLabel/Barcode.aspx?ShipmentNo=1Z964AX56800000666&LabelKey=084C3793-5802-42B6-9BC7-48CC627656B4&Type=Print"
},
"error": 0
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.
  • message (string): işlem durum mesajı
  • cargoKey (string): kargo anahtarı
  • cargoLabelLink (string): Barkod çıkarabilmek için kargo firmasının gönderdiği link.

Kargo İptal (Entegrasyon)


Narwoo.com'un anlaşmalı olduğu kargo firmalarından hangisini kullandıysanız o firmanın entegrasyonunu iptal edin.

Sistemimiz şimdilik sadece UPS kargo firmasını desteklenmektedir.

Method: POST
URL: https://www.narwoo.com/api/cargo-cancel/integration
Gerekli Parametreler: token, order_number

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
    "errCode": 0,
    "message": "İşlem Başarılı"
},
"error": 0
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.
  • message (string): işlem durum mesajı

Kargo Detay (Entegrasyon)


Narwoo.com'un anlaşmalı olduğu kargo firmalarından hangisini kullandıysanız o firmanın entegrasyonunu iptal edin.

Sistemimiz şimdilik sadece UPS kargo firmasını desteklenmektedir.

Method: GET
URL: https://www.narwoo.com/api/cargo-detail/integration
Gerekli Parametreler: token, order_number cargo_number

Dönen Değerler

Veri Türü: JSON
Eğer tüm gönderilen parametreler doğruysa çıktı örneği aşağıdaki gibidir:
"o": {
    "errCode": 0,
    "message": "İşlem Başarılı",
    "cargo_details": {
        "cargo_status": "Kargo İşlem Görmemiş",
        "cargo_number": "1Z964AX56800000684",
        "cargo_company_name": "UPS",
        "cargo_link": "//www.ups.com.tr/WaybillSorgu.aspx?Waybill=1Z964AX56800000684",
        "cargo_integration": "1"
    }
},
"error": 0
  • errCode (integer): istek durumunda oluşan hata kodu
    • 0 işlem başarılı
    • 1+ 1 veya üstü hata kodları dönerse işlem başarısız demektir.
  • message (string): işlem durum mesajı
  • cargo_details (array): işlem durum mesajı
    • cargo_status (string): Kargonun durum mesajı
    • cargo_number (string): Kargo numarası
    • cargo_company_name (string): Kargo şirketinin adı
    • cargo_link (string): Kargo durum bilgisini daha detaylı alabilmek için kargo şirketine yönlendirme linki
    • cargo_integration (integer): bu siparişin kargo gönderim şekli
      • 0 Manuel kargo sistemi
      • 1 Entegrasyon kargo sistemi

API Hata Kodları


Kullanmış olduğunuz API servislerimizden dönen hata kodları aşağıdadır.

public function return_message($error_code = 1)
{
    // Error Codes and Messages
    $error = [];

    $error[0]['errCode'] = 0;
    $error[0]['message'] = "İşlem Başarılı";

    $error[1]['errCode'] = 1;
    $error[1]['message'] = "Bir hata oluştu.";

    $error[4]['errCode'] = 4;
    $error[4]['message'] = "Sipariş zaten onaylanmış";

    $error[5]['errCode'] = 5;
    $error[5]['message'] = "Siparişteki ürünlerin hepsi onaylanamadı.";

    $error[6]['errCode'] = 6;
    $error[6]['message'] = "Yetkilendirilmemiş.";

    $error[7]['errCode'] = 7;
    $error[7]['message'] = "Hatalı istek, token bulunamadı.";

    $error[8]['errCode'] = 8;
    $error[8]['message'] = "Hatalı istek, sipariş numarası bulunamadı.";

    $error[9]['errCode'] = 9;
    $error[9]['message'] = "Sipariş bulunamadı.";

    $error[10]['errCode'] = 10;
    $error[10]['message'] = "Sipariş iptal edilmiş.";

    $error[11]['errCode'] = 11;
    $error[11]['message'] = "Alıcı sipariş ücretini henüz ödememiş.";

    $error[12]['errCode'] = 12;
    $error[12]['message'] = "Hatalı istek, kargo bulunamadı.";

    $error[13]['errCode'] = 13;
    $error[13]['message'] = "Hatalı istek, kargo numarası bulunamadı.";

    $error[14]['errCode'] = 14;
    $error[14]['message'] = "Kargo numarası en az 6 hane olmalıdır.";

    $error[15]['errCode'] = 15;
    $error[15]['message'] = "Kargo bulunamadı.";

    $error[16]['errCode'] = 16;
    $error[16]['message'] = "Bu siparişin zaten bir kargo numarası var.";

    $error[17]['errCode'] = 17;
    $error[17]['message'] = "Bu siparişte bir ürün iadesi mevcut.";

    $error[18]['errCode'] = 18;
    $error[18]['message'] = "Bu siparişte kargo entegrasyonu kullanılıyor.";
    
    $error[18]['errCode'] = 41;
    $error[18]['message'] = "Geçerli token değeri bulunamadı.";
    
    $error[18]['errCode'] = 42;
    $error[18]['message'] = "Eksik parametre";
    
    $error[18]['errCode'] = 43;
    $error[18]['message'] = "Ürün silinirken hata oluştu.";

    return $error[$error_code];
}