T-SOFT/Storefront API/Kargo Firmaları

Kargo Firmaları

Mağazada tanımlı kargo firmalarını döndürür. Teslimat seçeneği listesi, iade akışında firma seçimi ve kargo logosu göstermek için kullanılır. Salt-okunur bir kaynaktır.

Yetki:storefront:read — herkese açık, token isteğe bağlı.

Listeleme

GET /cargo-companies

curl -s 'https://<domain>/api/v3/storefront/2026-01/cargo-companies?filter[isActive]=true' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer <TOKEN>'

Örnek bir kargo firması kaydı:

{
  "type": "cargo-companies",
  "id": "3",
  "attributes": {
    "name": "Yurtiçi Kargo",
    "code": "yurtici",
    "type": "standard",
    "sortOrder": 1,
    "returnable": true,
    "isActiveForCustomer": true,
    "logoUrl": "https://<domain>/Data/kargo/yurtici.png"
  }
}

Varsayılan sıralama sortOrder, ardından name alanına göredir.

Tek kayıt

GET /cargo-companies/{id}

curl -s 'https://<domain>/api/v3/storefront/2026-01/cargo-companies/3' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer <TOKEN>'

Yanıt yapısı listeleme ile aynıdır; data tekil obje döner. Tanımsız id → 404.

Alanlar

Alan	Açıklama
`name`	Firma adı
`code`	Firma kodu (entegrasyon anahtarı)
`type`	Kargo türü
`sortOrder`	Panelde tanımlı görüntüleme sırası
`returnable`	İade gönderilerinde kullanılabilir mi
`isActiveForCustomer`	Müşteri tarafında (vitrin) seçilebilir mi
`logoUrl`	Firma logosunun tam URL'i; yoksa boş string

Filtreler

Filtre	Örnek	Davranış
`filter[id]`	`filter[id]=3,7`	Belirli id'lerle sınırla — virgülle birden fazla
`filter[isActive]`	`filter[isActive]=true`	Müşteri tarafında aktif firmalara daralt

Sıralama

Sort	Anlamı
`sortOrder` / `-sortOrder`	Panelde tanımlı sıra
`name` / `-name`	Firma adı