Sipariş Objesini Oluşturmak

Sipariş Objesini Oluşturmak

  • Sipariş objesi JSON formatında olmalı. Sipariş içinde temel bilgiler, siparişte yer alan ürünler ve bu ürünlere ait bazı bilgiler bulunur. Aşağıda her bir parametre ayrı ayrı açıklanmıştır.

Parametreler

Sipariş Parametreleri

ParametreAçıklamaTür
CustomerNameSiparişi veren kullanıcının adıstring
CustomerSurnameSiparişi veren kullanıcının soyadıstring
CustomerIdKendi sisteminize kayıtlı kullanıcının ID’si, yoksa boş bırakınstring
CustomerPhoneSiparişi veren kullanıcının telefon numarasıstring
CustomerPhone2Siparişi veren kullanıcının 2.telefon numarasıstring
AddressSiparişi veren kullanıcının adresistring
AddressDescriptionSiparişi veren kullanıcnın adres tarifistring
RegionSiparişi veren kullanıcnın semt-ilçe bilgisistring
CitySiparişi veren kullanıcının şehir bilgisistring
PaymentMethodIdÖdeme tipi bilgisiint
PaymentNoteÖdeme notustring
DiscountSiparişteki toplam indirim tutarıint
OrderNoteSipariş notustring
WebOrderIdKendi sisteminizde yer alan sipariş ID’sistring
OrderTotalSipariş Toplam Tutarıint
ParentIdAna ürünün ID'siint

OrderDetails Parametreleri

Products apisinden alınan ürün listesini baz alarak, oluşturacağınız siparişlerin ürün detaylarında ProductUnitId veya ProductCode alanlarından sadece birini tercih etmeniz gerekiyor. Siparişteki ürün listesini oluştururken bu alanlardan sadece birini doldurup diğerini null veya hiç değer girmeden göndermeniz gerekiyor.

ParametreAçıklamaTürZorunlu Mu?
QuantitySipariş içerisindeki ürünün miktarıintEvet
NameSipariş içerisindeki ürünün adıstringEvet
ProductUnitIdSipariş içerisindeki birimin Id'siintEvet
ProductCodeSipariş içerisindeki ürün kodustringHayır
OrderDetailNoteÜrün notustringHayır
FeaturesSipariş içerisindeki ürünün özellik listesiList<Object>Hayır
IsMenuSiparişi içerisindeki ürünün menü olup olmadığının bilgisibooleanHayır
MenuIdSipariş içerisindeki ürünün menü Id'siintHayır
ParentIdSipariş içerisindeki ana ürünün ID'sistringHayır

Menu ve Parent Id Kullanımı

Bir ürünün MenuId ve ParentId değerleri aynı olmamalıdır. Sipariş içindeki bir ürün, farklı bir menü altında bulunuyorsa, kendisine ait bir ParentId değeri olmalıdır. Aksi takdirde, ParentId gönderilmemeli veya null olarak belirtilmelidir.

Örnek Kullanım

  • Menü İçeren Ürünler

    • Hamburger bir menüdür, bu nedenle kendisine ait bir MenuId değeri vardır.
    • Kola, Hamburger Menüsü altında yer aldığı için ParentId değeri, Hamburger’in MenuId değeri ile aynı olmalıdır.
Menü İçeren Ürünler
[
    {
        "Quantity": 1,
        "ProductUnitId": 123,
        "IsMenu": true,
        "MenuId": 1,
        "ParentId": null
    },
    {
        "Quantity": 1,
        "ProductUnitId": 234,
        "IsMenu": false,
        "MenuId": null,
        "ParentId": 1
    }
]
  • Bağımsız Ürünler

    • Eğer Kola herhangi bir menüye bağlı değilse, ParentId parametresi gönderilmemelidir.
Bağımsız Ürünler
[
    {
        "Quantity": 1,
        "ProductUnitId": 123,
        "IsMenu": false,
        "MenuId": null,
        "ParentId": null
    },
    {
        "Quantity": 1,
        "ProductUnitId": 234,
        "IsMenu": false,
        "MenuId": null,
        "ParentId": null
    }
]

Örnek Sipariş Objesi

Örnek Sipariş Objesi
{
    "CustomerName": "Christian",
    "CustomerSurname": "Luyindama",
    "CustomerId": "44545",
    "CustomerPhone": "5554443444",
    "CustomerPhone2": "5554443441",
    "Address": "Adres bilgisi...",
    "AddressDescription": "Adres tarif",
    "Region": "Ataşehir",
    "City": "İstanbul",
    "PaymentMethodId": 3,
    "PaymentNote": "temassız çalışmıyorr",
    "Discount": 20,
    "OrderNote": "ıslak mendil getirin",
    "WebOrderId": "746364",
    "OrderTotal": "20.00",
    "OrderDetails": [
            {
                "Quantity": 1,
                "ProductCode": null,
                "Name": "Efsane Menu",
                "OrderDetailNote": null,
                "IsMenu": true,
                "ProductUnitId": 7324219,
                "MenuId": 1
            },
            {
                "Quantity": 1,
                "ProductCode": null,
                "Name": "Cheeseburger",
                "OrderDetailNote": null,
                "IsMenu": false,
                "ProductUnitId": 7324216,
                "ParentId": "1"
            },
            {
                "Quantity": 1,
                "ProductCode": null,
                "Name": "Kola",
                "OrderDetailNote": null,
                "IsMenu": false,
                "ProductUnitId": 7324245,
                "ParentId": "1"
            },
            {
                "Quantity": 1,
                "ProductCode": null,
                "Name": "Brownie",
                "OrderDetailNote": null,
                "IsMenu": false,
                "ProductUnitId": 7324214
            }
        ]
}