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": {
    "id": 1,
    "document_id": "ORD-001",
    "contact_id": 1,
    "contact_name": "Örnek Müşteri",
    "address_id": 1,
    "order_date": "2024-01-15",
    "currency": "TRY",
    "total_amount": 1180.0,
    "vat_amount": 180.0,
    "net_amount": 1000.0,
    "status": "active",
    "items": [
      {
        "id": 1,
        "product_id": 1,
        "product_name": "Örnek Ürün",
        "quantity": 2,
        "unit_price": 500.0,
        "vat_rate": 18,
        "total": 1180.0,
        "vat_amount": 180.0,
        "net_amount": 1000.0
      }
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Yanıt Alanları

Alan	Tip	Açıklama
id	integer	Sipariş ID
document_id	string	Sipariş numarası
contact_id	integer	Müşteri/cari ID
contact_name	string	Müşteri adı
address_id	integer	Adres ID
order_date	string	Sipariş tarihi
currency	string	Para birimi
total_amount	number	Toplam tutar
vat_amount	number	KDV tutarı
net_amount	number	Net tutar
status	string	Sipariş durumu
items	array	Sipariş kalemleri
created_at	string	Oluşturulma tarihi
updated_at	string	Güncellenme tarihi

Kurallar

Önemli

• Sipariş ID: Geçerli bir sipariş ID'si olmalı
• Erişim: Sadece şirketinize ait siparişlere erişebilirsiniz
• Durum: Sipariş durumu (active, completed, cancelled, converted)
• Kalemler: Items array'i sipariş kalemlerini içerir
• Tarih: Tarih formatı ISO 8601 standardında