Ganipara REST API v1.0 Dokümantasyonu

Anasayfa/ API/ REST API v1.0

Ganipara Rest API v1.0

Sipariş

Sipariş API referansı siparişler hakkında bilgi almak için kullanılır

Methodlar

Sipariş detay Detay
Sipariş listele Detay
Sipariş kargo detayı güncelle Detay
Sipariş fatura meta verisi güncelle Detay

Sipariş detay

https://api.ganipara.com/1.0/order/detail/ GET
Sipariş detayları
Paremetre Tür Zorunlu
id
Sipariş ID'si
Sayı Evet
GET /1.0/order/detail/

{
   "id":"1749"
}
{
  "status": true,
  "order": {
    "id": "1749",
    "order_number": "SIPARIS-CHYJN-AC23S-HNJH61213",
    "order_date": "2013-12-06T12:29:12+0100",
    "ip": "198.167.2.12",
    "transaction_id": "3250",
    "status": "complete",
    "payment_type": "creditcard",
    "payatdoor_type": "cash",
    // Sadece Kapıda Ödeme seçeneğinde belirtilir.
    "gateway": "iyzico",
    "buyer": {
      "name": "Ayşegül Nazlı",
      "email": "aysegul@alanadi.com",
      "phone": "(532) 1111111"
    },
    "note": "",
    "currency": "TRY",
    "amount": "393.00",
    "amount_subtotal": "300.00",
    "amount_cargo": "90.00",
    "amount_giftwrap": "3.00",
    "amount_gateway": "10.00",
    "amount_discount": "-10.00",
    "amount_installment": "0.00",
    "billing": {
      "type": "personal",
      "name": "Ayşegül Nazlı",
      "address": "Sümer 2.Sok No:36/2 Kızılay",
      "city": "Ankara",
      "town": "Çankaya",
      "country": "TR",
      "state": "",
      "zipcode": "06650"
    },
    "shipping": {
      "name": "Berkay UNAL",
      "address": "Sümer 2.Sok No:36/2 Kızılay",
      "city": "Ankara",
      "town": "Çankaya",
      "country": "TR",
      "zipcode": ""
    },
    "shipping_rate": {
      "id": "186",
      "title": "Standart Kargo",
      "description": "",
      "courier_id_default": "32"
    },
    "has_download": false,
    "items": [
      {
        "id": "171089",
        "product_id": "534059",
        "url": "http://shop.alanadi.com/product/detail/urun-1",
        "name": "Ürün 1",
        "sub_name": "",
        "sub_name_keys": "",
        "sku": "2.57C.F8D.A6F7",
        "gtin": null,
        "type": "product",
        "product_type": "tangible",
        "unit_price": "100.00",
        "quantity": 1,
        "quantity_type": "integer",
        "total_price": "100.00",
        "status": "ready",
        "photo": "https://cdn-merchant.ganipara.home/assets/1321/product/14123/large_il_fullxfull.jpg"
      },
      {
        "id": "171090",
        "product_id": "534058",
        "url": "http://shop.alanadi.com/product/detail/urun-2",
        "name": "Ürün 2",
        "sub_name": "M",
        "sub_name_keys": "Beden",
        "sku": "2.57C.EA0.0DF1",
        "gtin": null,
        "type": "product",
        "product_type": "tangible",
        "unit_price": "100.00",
        "quantity": 1,
        "quantity_type": "integer",
        "total_price": "100.00",
        "status": "ready",
        "photo": ""
      },
      {
        "id": "171091",
        "product_id": "534057",
        "url": "http://shop.alanadi.com/product/detail/urun-3",
        "name": "Ürün 3",
        "sub_name": "",
        "sub_name_keys": "",
        "sku": "2.57C.D41.01C9",
        "gtin": null,
        "type": "product",
        "product_type": "tangible",
        "unit_price": "100.00",
        "quantity": 1,
        "quantity_type": "integer",
        "total_price": "100.00",
        "status": "ready",
        "photo": ""
      }
    ],
    "product_ids": [
      "534059",
      "534058",
      "534057"
    ],
    "invoice_data": {
      "title": "Ayşegül Nazlı",
      "tax_number": "",
      "tax_office": "",
      "address": "Sümer 2.Sok No:36/2 Kızılay Çankaya Ankara/Türkiye",
      "items": [
        {
          "line_type": "product",
          "name": "Ürün 1",
          "sub_name": "",
          "sub_name_keys": "",
          "product_id": "534059",
          "sku": "2.57C.F8D.A6F7",
          "gtin": "",
          "quantity": 1,
          "quantity_type": "integer",
          "photo": "https://cdn-merchant.ganipara.home/assets/1321/product/14123/large_il_fullxfull.jpg",
          "vat_rate": "1",
          "unit_price": {
            "with_vat": 100,
            "without_vat": 99.01,
            "vat_amount": 0.98999999999999
          },
          "total_price": {
            "with_vat": 100,
            "without_vat": 99.01,
            "vat_amount": 0.98999999999999
          }
        },
        {
          "line_type": "product",
          "name": "Ürün 2",
          "sub_name": "M",
          "sub_name_keys": "Beden",
          "product_id": "534058",
          "sku": "2.57C.EA0.0DF1",
          "gtin": "",
          "quantity": 1,
          "quantity_type": "integer",
          "photo": "",
          "vat_rate": "18",
          "unit_price": {
            "with_vat": 100,
            "without_vat": 84.75,
            "vat_amount": 15.25
          },
          "total_price": {
            "with_vat": 100,
            "without_vat": 84.75,
            "vat_amount": 15.25
          }
        },
        {
          "line_type": "product",
          "name": "Ürün 3",
          "sub_name": "",
          "sub_name_keys": "",
          "product_id": "534057",
          "sku": "2.57C.D41.01C9",
          "gtin": "",
          "quantity": 1,
          "quantity_type": "integer",
          "photo": "",
          "vat_rate": "8",
          "unit_price": {
            "with_vat": 100,
            "without_vat": 92.59,
            "vat_amount": 7.41
          },
          "total_price": {
            "with_vat": 100,
            "without_vat": 92.59,
            "vat_amount": 7.41
          }
        },
        {
          "line_type": "cargo",
          "name": "Kargo ücreti",
          "sub_name": "",
          "sub_name_keys": "",
          "product_id": "",
          "sku": "",
          "gtin": "",
          "quantity": "1",
          "quantity_type": "integer",
          "vat_rate": "18",
          "unit_price": {
            "with_vat": 90,
            "without_vat": 76.27,
            "vat_amount": 13.73
          },
          "total_price": {
            "with_vat": 90,
            "without_vat": 76.27,
            "vat_amount": 13.73
          }
        },
        {
          "line_type": "gateway",
          "name": "Ödeme altyapısı komisyon ücreti",
          "sub_name": "",
          "sub_name_keys": "",
          "product_id": "",
          "sku": "",
          "gtin": "",
          "quantity": "1",
          "quantity_type": "integer",
          "vat_rate": "18",
          "unit_price": {
            "with_vat": 10,
            "without_vat": 8.47,
            "vat_amount": 1.53
          },
          "total_price": {
            "with_vat": 10,
            "without_vat": 8.47,
            "vat_amount": 1.53
          }
        },
        {
          "line_type": "giftwrap",
          "name": "Hediye paketi ücreti",
          "sub_name": "",
          "sub_name_keys": "",
          "product_id": "",
          "sku": "",
          "gtin": "",
          "quantity": "1",
          "quantity_type": "integer",
          "vat_rate": "18",
          "unit_price": {
            "with_vat": 3,
            "without_vat": 2.54,
            "vat_amount": 0.46
          },
          "total_price": {
            "with_vat": 3,
            "without_vat": 2.54,
            "vat_amount": 0.46
          }
        }
      ],
      "vat": [
        {
          "rate": 18,
          "amount": 30.97
        },
        {
          "rate": 8,
          "amount": 7.41
        },
        {
          "rate": 1,
          "amount": 0.98
        }
      ],
      "sub_total": 363.63,
      "vat_total": 39.37,
      "discount": "-10.00",
      "grand_total": "393.00"
    },
    "invoice_meta": {
      "invoice_printed": true,
      "invoice_number": "AXXXXXXXXX",
      "invoice_ettn": "88ac31aa-e114-11e8-bf91-14fXXXXXXXX"
    },
    "merchant_safe_data": {
    }
  }
}

Sipariş listele

https://api.ganipara.com/1.0/order/list/ GET
Sipariş listele
Paremetre Tür Zorunlu
status
Sipariş durumu
'payment_complete', 'complete', 'cancelled'
Metin Hayır
date_start
Başlangıç tarihi (ISO 8601 formatında)
Tarih Hayır
date_end
Bitiş tarihi (ISO 8601 formatında)
Tarih Hayır
limit
Sayfa başına listenecek kayıt sayısı (10, 25, 50)
Sayı Hayır
page
Listenecek sayfa
Sayı Hayır
Sipariş detayı döndürür. Detaylar için buraya takınız.
GET /1.0/order/list/

{
   "limit":"50",
   "page":"1",
   "date_start":"2016-11-01T10:59:26+0300"
}
{
   "status":true,
   "order":[
      {
        ...
      },
      {
        ...
      }
   ],
   "_metadata": {
        "page": 1,
        "limit": 50,
        "page_count": 4,
        "total_count": 188
    }
}

Sipariş kargo detayı güncelle

https://api.ganipara.com/1.0/order/update/cargo-detail POST
Sipariş kargo detayları güncelle
Paremetre Tür Zorunlu
id
Sipariş ID'si
Sayı Evet
description
Kargo detayı hakkında ek açıklama. Sipariş detay sayfasında görüntülenir.
Metin Hayır
notify
Müşteriye eposta gönderilsin mi?

1: Evet
0: Hayır

Metin Hayır
mark_complete
Sipariş tamamlandı olarak işaretlensin mi?

1: Evet
0: Hayır

Metin Hayır
courier_tracking_number
Kargo takip numarası

Kullanılabilmesi için "courier_id" değerinin gönderilmesi zorunludur.

Metin Hayır
courier_id
Kargo firması ID değeri
0 gönderilmesi varsayılan değerin kullanılmasını sağlar

Detay

Metin Hayır
from_id
Depo ID değeri
0 gönderilmesi varsayılan değerin kullanılmasını sağlar

Detay

Metin Hayır
POST /1.0/order/update/cargo-detail

{
    "id":"1749",
    "description" : "Siparişiniz için teşekkür ederiz",
    "notify" : "1",
    "mark_complete" : "1",
    "courier_tracking_number" : "123456789",
    "from_id" : "20",
    "courier_id" : "31",
}
{
  "status": true
}

Sipariş fatura meta verisi güncelle

https://api.ganipara.com/1.0/order/update/invoice-meta POST
Sipariş fatura meta verisi güncelle
Paremetre Tür Zorunlu
id
Sipariş ID'si
Sayı Evet
invoice_date
Fatura Tarihi (ISO 8601 formatında)
Tarih Hayır
invoice_shipping_date
Fatura Fiili Sevk Tarihi (ISO 8601 formatında)
Tarih Hayır
invoice_number
Fatura Numarası
Metin Hayır
invoice_printed
Fatura basıldı mı?

1: Evet
0: Hayır

Metin Hayır
invoice_type
Fatura türü

paper: Fatura
digital: E-Fatura

Metin Hayır
invoice_ettn
Fatura ETTN kimliği
Metin Hayır
POST /1.0/order/update/invoice-meta

{
    "id":"1749",
    "invoice_date" : "Siparişiniz için teşekkür ederiz",
    "notify" : "1",
    "mark_complete" : "1",
    "courier_tracking_number" : "123456789",
    "from_id" : "20",
    "courier_id" : "31",
}
{
  "status": true
}
  • Ganipara alışveriş sitesi açmak için en iyi çözüm. Tavsiye ederim

    Melike

  • Ürünlerimi internetten satmak için ihtiyaç duyduğum tek websitesi

    Orçun

Yukarı