Sipariş Detayı

Belirtilen siparişin detay bilgilerini getirir.

Endpoint

GET /kolaybi/v1/orders/{document_id}

Parametreler

Parametre	Tip	Zorunlu	Açıklama
document_id	integer	Evet	Detayı alınacak sipariş ID'si

Örnekler

cURL

curl -X GET "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/orders/1" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Channel: YOUR_CHANNEL"

JavaScript

async function getOrderDetail(documentId) {
  const response = await fetch(
    `https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/orders/${documentId}`,
    {
      method: "GET",
      headers: {
        Authorization: `Bearer ${accessToken}`,
        Channel: channel,
      },
    }
  );

  return await response.json();
}

// Kullanım
const order = await getOrderDetail(1);

PHP

function getOrderDetail($documentId) {
    $url = "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/orders/{$documentId}";

    $ch = curl_init();
    curl_setopt_array($ch, [
        CURLOPT_URL => $url,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer ' . $accessToken,
            'Channel: ' . $channel
        ],
        CURLOPT_RETURNTRANSFER => true
    ]);

    $response = curl_exec($ch);
    curl_close($ch);

    return json_decode($response, true);
}

// Kullanım
$order = getOrderDetail(1);

Python

import requests

def get_order_detail(document_id):
    url = f"https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/orders/{document_id}"
    headers = {
        "Authorization": f"Bearer {access_token}",
        "Channel": channel
    }

    response = requests.get(url, headers=headers)
    return response.json()

# Kullanım
order = get_order_detail(1)

C#

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using Newtonsoft.Json;

async Task<dynamic> GetOrderDetailAsync(int documentId)
{
    using var client = new HttpClient();

    var request = new HttpRequestMessage(HttpMethod.Get,
        $"https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/orders/{documentId}");

    request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
    request.Headers.Add("Channel", channel);

    var response = await client.SendAsync(request);
    var content = await response.Content.ReadAsStringAsync();
    return JsonConvert.DeserializeObject<dynamic>(content);
}

// Kullanım
var order = await GetOrderDetailAsync(1);

Yanıt

Başarılı Yanıt

{
  "data": {
    "document_id": 145,
    "exchange_grand_total": 450,
    "exchange_grand_currency": "try",
    "grand_total": 450,
    "grand_currency": "usd",
    "order_number": "SIP-2024-001",
    "associate_id": 1,
    "currency": "usd",
    "description": "Test siparişi",
    "lines": [
      {
        "product_id": 1,
        "product_name": "Test Ürün",
        "unit": "adet",
        "quantity": 2,
        "unit_price": 100,
        "description": "Açıklama",
        "grand_total": 240,
        "total": 200,
        "vat_amount": 40,
        "vat_value": 20,
        "vat_type": "percentage",
        "subtotal": 200,
        "discount_amount": 0,
        "discount_value": 0,
        "discount_type": "percentage",
        "amount": 200
      }
    ],
    "invoice_document_ids": [1854],
    "proforma_document_ids": []
  }
}

Yanıt Alanları

Alan	Tip	Açıklama
document_id	integer	Sipariş ID
order_number	string	Sipariş numarası
associate_id	integer	Carinin ID değeri
currency	string	Sipariş para birimi
description	string	Sipariş açıklaması
grand_total	number	KDV dahil toplam
grand_currency	string	Sipariş para birimi (grand total)
exchange_grand_total	number	Şirket para birimindeki karşılık
exchange_grand_currency	string	Şirket para birimi
lines	array	Sipariş kalemleri (lines[n])
invoice_document_ids	array	Siparişten türeyen faturaların ID listesi
proforma_document_ids	array	Siparişten türeyen proformalar

Kalem Alanları (lines[n])

Alan	Tip	Açıklama
product_id	integer	Ürünün ID değeri
product_name	string	Ürün adı
unit	string	Ölçü birimi (adet, kutu vb.)
quantity	number	Satılan miktar
unit_price	number	Birim fiyat
description	string	Satır açıklaması
amount	number	Toplam tutar (iskonto uygulanmadan)
subtotal	number	KDV hariç toplam
total	number	KDV hariç toplam (iskontolar sonrası)
grand_total	number	KDV dahil toplam
vat_amount	number	Satıra ait toplam KDV tutarı
vat_value	number	KDV oranı
vat_type	string	KDV tip bilgisi (percentage, fixed)
discount_amount	number	Toplam indirim tutarı
discount_value	number	İndirim oranı veya tutarı
discount_type	string	İndirim tipi (percentage, amount)