Adres Oluşturma
Müşteri/cari için yeni adres oluşturma.
Endpoint
POST /kolaybi/v1/address/create
Parametreler
| Parametre | Tip | Zorunlu | Açıklama |
|---|---|---|---|
associate_id | integer | Evet | Adres eklenecek cari ID |
address | string | Hayır | Adres satırı |
city | string | Hayır | Şehir adı |
district | string | Hayır | İlçe adı |
country | string | Hayır | Ülke adı |
address_type | string | Hayır | Adres tipi (varsayılan: invoice) |
is_abroad | boolean | Hayır | Yurt dışı adresi ise true |
street | string | Hayır | Sokak bilgisi (is_abroad true olursa zorunlu) |
building_name | string | Hayır | Bina adı (is_abroad true olursa zorunlu) |
number | number | Hayır | Bina numarası (is_abroad true olursa zorunlu) |
postal_code | string | Hayır | Posta kodu (is_abroad true olursa zorunlu) |
address_location | string | Hayır | Adres konumu (varsayılan: other) |
Örnekler
- cURL
- JavaScript
- PHP
- Python
- C#
curl -X POST "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/address/create" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Channel: YOUR_CHANNEL" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "associate_id=1&address=Test Mahallesi&city=İstanbul&district=Kadıköy&address_type=invoice"
async function createAddress(data) {
const formData = new URLSearchParams(data);
const response = await fetch(
"https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/address/create",
{
method: "POST",
headers: {
Authorization: `Bearer ${accessToken}`,
Channel: channel,
"Content-Type": "application/x-www-form-urlencoded",
},
body: formData,
}
);
return await response.json();
}
// Kullanım
const address = await createAddress({
associate_id: 1,
address: "Test Mahallesi",
city: "İstanbul",
district: "Kadıköy",
address_type: "invoice",
});
function createAddress($data) {
$url = 'https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/address/create';
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => $url,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query($data),
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $accessToken,
'Channel: ' . $channel,
'Content-Type: application/x-www-form-urlencoded'
],
CURLOPT_RETURNTRANSFER => true
]);
$response = curl_exec($ch);
curl_close($ch);
return json_decode($response, true);
}
// Kullanım
$address = createAddress([
'associate_id' => 1,
'address' => 'Test Mahallesi',
'city' => 'İstanbul',
'district' => 'Kadıköy',
'address_type' => 'invoice'
]);
import requests
def create_address(data):
url = "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/address/create"
headers = {
"Authorization": f"Bearer {access_token}",
"Channel": channel,
"Content-Type": "application/x-www-form-urlencoded"
}
response = requests.post(url, headers=headers, data=data)
return response.json()
# Kullanım
address = create_address({
"associate_id": 1,
"address": "Test Mahallesi",
"city": "İstanbul",
"district": "Kadıköy",
"address_type": "invoice"
})
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using Newtonsoft.Json;
async Task<dynamic> CreateAddressAsync(Dictionary<string, string> data)
{
using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post,
"https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/address/create")
{
Content = new FormUrlEncodedContent(data)
};
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 address = await CreateAddressAsync(new Dictionary<string, string>
{
{ "associate_id", "1" },
{ "address", "Test Mahallesi" },
{ "city", "İstanbul" },
{ "district", "Kadıköy" },
{ "address_type", "invoice" }
});
Yanıt
- Başarılı Yanıt
{
"data": {
"id": 1,
"address": "Berlin-Almanya",
"coutry_name": "Almanya",
"postal_code": "10115",
"is_abroad": true,
"building_name": "ABC",
"number": 35,
"street": "A",
"address_type": "invoice",
"city": "Berlin",
"district": "Mitte"
}
}
Yanıt Alanları
| Alan | Tip | Açıklama |
|---|---|---|
id | integer | Oluşturulan adres ID |
address | string | Adres bilgisi |
country_name | string | Ülke adı |
postal_code | string | Posta kodu |
is_abroad | boolean | Yurt dışı adres bilgisi |
building_name | string | Bina adı |
number | number | Bina numarası |
street | string | Sokak |
address_type | string | Adres tipi (invoice, delivery vb.) |
city | string | Şehir |
district | string | İlçe |