{ "openapi": "3.0.0", "info": { "title": "HEPSILOJISTIK - SIPARIS YONETIMI", "version": "0.1" }, "servers": [ { "url": "https://radium.hepsiburada.com" } ], "paths": { "/api/claims/create": { "post": { "tags": [ "Talep Entegrasyonu" ], "summary": "Aksiyon Bekleyen Talep Bildirimi", "description": "Aksiyon Bekleyen Talep Bildirimleri Radium sistemine bu method yardımıyla iletilecektir.", "operationId": "13967aa5a8dcf25203f1affc615a2152", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "claimNumber": { "description": "Claim unique numara bilgisi", "type": "integer" }, "type": { "description": "Claimin tipi", "type": "string" }, "typeDescription": { "description": "Claim tipinin açıklaması", "type": "string" }, "customerName": { "description": "Müşteri adı", "type": "string" }, "orderNumber": { "description": "Sipariş numarası", "type": "integer" }, "explanation": { "description": "Claim müşteri açıklaması", "type": "string" }, "claimDate": { "description": "Claim oluşturulma tarihi", "type": "string" }, "orderDate": { "description": "Sipariş tarihi", "type": "string" }, "lines": { "properties": { "productName": { "description": "Ürün adı", "type": "string" }, "quantity": { "description": "Claim miktarı", "type": "integer" }, "productImageUrlFormat": { "description": "Ürün resim linki", "type": "integer" }, "merchantSku": { "description": "Ürün sku", "type": "string" }, "price": { "description": "Fiyat", "type": "string" }, "totalPrice": { "description": "Toplam Fiyat", "type": "integer" } }, "type": "object" }, "reports": { "properties": { "imageUrl": { "description": "Müşteri tarafından yüklenen rapor görsel linki", "type": "string" }, "reportedBy": { "description": "Raporun kimin taraffından verildiği", "type": "string" } }, "type": "object" }, "delivery": { "properties": { "code": { "description": "Teslimat Numarası (Eğer müşteri tarafından satıcı deposuna geri iade edilen bi paket var ise bilgisi)", "type": "string" }, "status": { "description": "Teslimat Durumu (Created, Delivered)", "type": "string" }, "direction": { "description": "\tCustomerToMerchant, MerchantToCustomer", "type": "string" }, "createdDate": { "description": "Teslimat Oluşturulma Tarihi", "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success or Fail message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string", "example": "OK." } }, "type": "object", "example": { "code": 200, "message": "OK" } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/api/claims/list": { "get": { "tags": [ "Talep Entegrasyonu" ], "summary": "Talep Listesi", "description": "Radium'a aktarılan talepler bu servis yardımıyla listelenir", "operationId": "589a4f741c36855951324c1f3f8ba85f", "parameters": [ { "name": "page", "in": "query", "description": "Sadece belirtilen sayfadaki bilgileri döndürür.", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "size", "in": "query", "description": "Bir sayfada listelenecek maksimum adeti belirtir", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "limit", "in": "query", "description": "listelenecek maksimum adeti belirtir.", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "claimNumber", "in": "query", "description": "Talep numarası ile uyuşan talebi listeler", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "A list with products", "content": { "application/json": { "schema": { "properties": { "totalElements": { "type": "number" }, "totalPages": { "type": "number" }, "page": { "type": "number" }, "size": { "type": "number" }, "content": { "type": "array", "items": { "properties": { "merchantOrderNumber": { "type": "string", "example": "80869231" }, "orderId": { "type": "number" }, "status": { "type": "string", "example": "OPEN" }, "lines": { "type": "array", "items": { "properties": { "merchantOrderLineNumber": { "type": "string", "example": "80869231-A" }, "orderLineId": { "type": "number" }, "quantity": { "type": "number" }, "cancelQuantity": { "type": "number" }, "shippedQuantity": { "type": "number" }, "remainQuantity": { "type": "number" } }, "type": "object" } } }, "type": "object" } } }, "type": "object", "example": { "totalElements": 1, "page": 1, "totalPages": 1, "size": 10, "content": [ { "merchantOrderNumber": "80869231", "orderId": 11650604, "status": "OPEN", "lines": [ { "merchantOrderLineNumber": "80869231-A", "orderLineId": 56040534, "quantity": 2, "cancelQuantity": 0, "shippedQuantity": 0, "remainQuantity": 2 } ] } ] } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/api/dailyStatusReport/list": { "get": { "tags": [ "Günlük Durum Rapor Entegrasyonu" ], "summary": "Günlük Durum Raporu", "description": "Günlük durum raporu bu servis yardımıyla listelenir. Not: Tarih Aralığı En Fazla 30 Gün Olabilir. Başlangış tarihi ve bitiş tarihi gönderilmez ise mevcut tarih'den bir önceki günün datası listelenecektir. Sadece başlangış tarihi gönderilir ise gönderilen tarihin datası listelenecektir. Başlangış tarihi ve bitiş tarihi gönderilir ise iki tarih arasındaki data listelenecektir.", "operationId": "ee7569229d6ac8f9f29acd8a40af7127", "parameters": [ { "name": "start_date", "in": "query", "description": "Belirli bir tarihten sonraki transfer hareketlerini getirir.", "required": false, "schema": { "type": "string" }, "example": "2022-10-11 05:21:56" }, { "name": "end_date", "in": "query", "description": "Belirtilen tarihe kadar olan transfer kareketlerini getirir.", "required": false, "schema": { "type": "string" }, "example": "2022-10-13 05:21:56" } ], "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success or Fail Message" } }, "security": [ { "basicAuth": [] } ] } }, "/api/delivery/list": { "get": { "tags": [ "Teslimat Entegrasyonu" ], "summary": "Teslimat Listesi", "description": "Teslimat bilgileri bu servis yardımıyla listelenir.", "operationId": "9c814f16560e8a54cf3a89eeae213ed1", "parameters": [ { "name": "page", "in": "query", "description": "Sadece belirtilen sayfadaki bilgileri döndürür.", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "size", "in": "query", "description": "Bir sayfada listelenecek maksimum adeti belirtir. Max 200", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "deliveryNumber", "in": "query", "description": "Teslimat numarasına göre filtreleme yapar.", "required": false, "schema": { "type": "string" }, "example": "10" }, { "name": "orderNumber", "in": "query", "description": "Sipariş numarasına göre filtreleme yapar.(importCode)", "required": false, "schema": { "type": "string" }, "example": "10" }, { "name": "startUpdateDate", "in": "query", "description": "Belirli bir tarihten sonra güncellenen teslimatları getirir.", "required": false, "schema": { "type": "string" }, "example": "10" }, { "name": "endUpdateDate", "in": "query", "description": "Belirtilen tarihe kadar olan güncellenen teslimatları getirir.", "required": false, "schema": { "type": "string" }, "example": "10" } ], "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "A list with products", "content": { "application/json": { "schema": { "properties": { "totalElements": { "type": "number" }, "totalPages": { "type": "number" }, "page": { "type": "number" }, "size": { "type": "number" }, "content": { "type": "array", "items": { "properties": { "merchantOrderNumber": { "type": "string", "example": "80869231" }, "orderId": { "type": "number" }, "status": { "type": "string", "example": "OPEN" }, "lines": { "type": "array", "items": { "properties": { "merchantOrderLineNumber": { "type": "string", "example": "80869231-A" }, "orderLineId": { "type": "number" }, "quantity": { "type": "number" }, "cancelQuantity": { "type": "number" }, "shippedQuantity": { "type": "number" }, "remainQuantity": { "type": "number" } }, "type": "object" } } }, "type": "object" } } }, "type": "object", "example": { "totalElements": 1, "page": 1, "totalPages": 1, "size": 10, "content": [ { "merchantOrderNumber": "80869231", "orderId": 11650604, "status": "OPEN", "lines": [ { "merchantOrderLineNumber": "80869231-A", "orderLineId": 56040534, "quantity": 2, "cancelQuantity": 0, "shippedQuantity": 0, "remainQuantity": 2 } ] } ] } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/api/delivery/invoice_link": { "post": { "tags": [ "Teslimat Entegrasyonu" ], "summary": "Teslimat Fatura Linki Güncelleme", "description": "Bu servis teslimatın fatura linkini günceller.", "operationId": "3f5623bfcb4fbbfa1cd6917d35de4e4f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "merchantOrderNumber": { "description": "Müşteri Sipariş Numarası", "type": "string", "example": "ORD12-4068986" }, "deliveryBarcode": { "description": "Teslimat Barkodu", "type": "string", "example": "BRC124068986" }, "invoiceLink": { "description": "Fatura Linki", "type": "string", "example": "https://extfatura.faturaentegratoru.com/324523-34523-52345-3453245.pdf", "x-nullable": true }, "invoiceBase64": { "description": "Base64 formatta fatura", "type": "string", "example": "JVBERi0xLjYNJeLjz9MNCjYxOSAwIG9iag08PC9GaWx0ZXIvRmxhdGVEZWNvZGUvRmlyc3QgMTczL0xlbmd0aCAyMDE0L04gMjAvVHlwZS9PYmpTdG0+PnN0cmVhbQ0KaN7EWHtv5DYO/yoC7p9d3NWy9bJ8KAJMkgk2uHST5tG9NggKxdbMCPHYUz/SpJ ... lC6M5CGszY1odlDeIsBP8CPAZo68fXH0PCN9AtvglwACMSnRODQplbmRzdHJlYW0NZW5kb2JqDXN0YXJ0eHJlZg0KMjYyOTg0DQolJUVPRg0K", "x-nullable": true } }, "type": "object" } } } }, "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success or Failed message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string", "example": "OK." } }, "type": "object", "example": { "code": 200, "message": "OK" } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/api/order/update_tracking_number": { "put": { "tags": [ "Sipariş" ], "summary": "Kargo No Güncelleme", "description": "Bu servis siparişin kargo no'sunu günceller.", "operationId": "90f031b634cb4271f514cd032a918b87", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "shipmentPackageId": { "description": "Sipariş id", "type": "integer", "example": "88877513398" }, "trackingNumber": { "description": "Kargo No", "type": "string", "example": "XYZ31231" } }, "type": "object" } } } }, "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string", "example": "88877513398 idli sipariş sistemde bulunamamıştır." } }, "type": "object", "example": { "code": 400, "message": "88877513398 idli sipariş sistemde bulunamamıştır" } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/api/order/invoice_link": { "post": { "tags": [ "Sipariş" ], "summary": "Fatura Linki Güncelleme", "description": "Bu servis siparişin fatura linkini günceller.", "operationId": "c94567a0f32167cecf64bca1f0b66808", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "shipmentPackageId": { "description": "Sipariş id", "type": "integer", "example": "124068986" }, "invoiceLink": { "description": "Fatura Linki", "type": "string", "example": "https://extfatura.faturaentegratoru.com/324523-34523-52345-3453245.pdf", "x-nullable": true } }, "type": "object" } } } }, "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success or Failed message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string", "example": "OK." } }, "type": "object", "example": { "code": 200, "message": "OK" } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/api/order/create": { "post": { "tags": [ "Sipariş" ], "summary": "Sipariş Yaratma", "description": "Siparişler Radium sistemine bu method yardımıyla iletilecektir. Ülke Kod Listesi, Platform kodu gibi bilgiler için bilgiler için lütfen destek ekibi ile iletişime geçiniz.", "operationId": "eecdfd63e759ef75b144e91aab846268", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "sale": { "properties": { "import_code": { "description": "Sipariş import kodu", "type": "integer", "example": "124068986" }, "sale_code": { "description": "Ekstra sipariş import kodu", "type": "integer", "example": "11650604" }, "sale_type": { "description": "IADE,SALE", "type": "integer", "example": "2" }, "subtotal": { "description": "Sipariş tutarı", "type": "integer", "example": "2" }, "cargo_fee": { "description": "Sipariş kargo tutarı", "type": "integer", "example": "2" }, "deliveryOption": { "description": "Teslimat Tipi. STD (Standart Delivery), BT (Same Day), ND (Next Day), FD (Fast Delivery) değerlerini alabilir. Varsayılan STD'dir.", "type": "string", "example": "STD" }, "cargo": { "description": "Sipariş kargo firması.", "type": "string", "example": "xxx" }, "trackingNumber": { "description": "Sipariş kargo numarası.", "type": "string", "example": "xxx" }, "grand_total": { "description": "Sipariş toplam tutarı", "type": "integer" }, "sale_bundle": { "description": "Bundle bilgisi", "type": "integer" }, "shipmentId": { "description": "shipmentId", "type": "integer" }, "platform": { "description": "Sipariş platform bilgisi", "type": "integer" }, "deliveryContractNo": { "description": "hjet sözleşme numarası gönderilecek", "type": "string" }, "deliveryMethodId": { "description": "deliveryMethodId", "type": "integer" }, "shippingMethodId": { "description": "shippingMethodId", "type": "integer" }, "shipper": { "description": "Siparişi sevk edecek nakliyeci bilgisi", "type": "integer" }, "cargoBranch": { "description": "Kargo firmalarına ait şube bilgisi", "type": "integer" }, "shipmentDate": { "description": "Siparişi sevk tarihi", "type": "integer" }, "hasPackagingInsert": { "description": "Paketleme aşamasında insert olsun mu? true ya da false olmalı. Boş olması durumunda default false olacaktır", "type": "string" }, "packagingInsertTitle": { "description": "Paketleme aşamasında varsa insert başlık bilgisi. Insert'ün adı, tipi vs.", "type": "string" }, "packagingInsertBody": { "description": "PPaketleme aşamasında varsa insert detay bilgisi. Insert'ün detayı, açıklaması vs.", "type": "string" }, "customer": { "properties": { "merchant_customer_number": { "description": "Sipariş import kodu", "type": "integer", "example": "124068986" }, "importCode": { "description": "Müşteri import kodu", "type": "integer", "example": "124068986" }, "firstname": { "description": "Müşteri adi", "type": "string", "example": "XXXX" }, "tax_number": { "description": "Vergi Numarası", "type": "string", "example": "124068986" }, "type": { "description": "Müşteri tipi; 'individual' (Bireysel) veya 'company' (Şirket) olabilir.", "type": "string", "example": "company" }, "lastname": { "description": "Müşteri Soyadı", "type": "string", "example": "XXX" }, "birthday": { "description": "Müşteri doğum tarihi", "type": "string", "example": "XXX" }, "email": { "description": "Müşteri e-mail adresi", "type": "string" }, "phone": { "description": "Müşteri telefon numarası", "type": "string" } }, "type": "object" }, "billing": { "properties": { "importCode": { "description": "\tFatura adresi için gerekli olan import kodu", "type": "integer" }, "firstname": { "description": "Fatura adresi için gerekli olan müşteri adı", "type": "string", "example": "124068986" }, "lastname": { "description": "Fatura adresi için gerekli olan müşteri soyadı", "type": "string" }, "city": { "description": "Fatura adresi için gerekli olan şehir", "type": "string" }, "country_code": { "description": "Fatura adresi için gerekli olan ülke kodu", "type": "string" }, "email": { "description": "Fatura adresi için gerekli olan e-mail adresi", "type": "string", "example": "XXX" }, "phone": { "description": "Fatura adresi için gerekli telefon numarası", "type": "string", "example": "XXX" }, "address": { "description": "\tFatura adresi için gerekli olan adres", "type": "string" }, "town": { "description": "Fatura adresi için gerekli olan ilçe", "type": "string" }, "district": { "description": "Fatura adresi için gerekli olan mahalle/cadde", "type": "string" }, "identity_number": { "description": "Fatura adresi için gerekli olan t.c", "type": "string" } }, "type": "object" }, "shipping": { "properties": { "importCode": { "description": "\tSipariş adresi için gerekli olan import kodu", "type": "integer" }, "firstname": { "description": "Sipariş adresi için gerekli olan müşteri adı", "type": "string" }, "lastname": { "description": "Sipariş adresi için gerekli olan müşteri soyadı", "type": "string" }, "city": { "description": "Sipariş adresi için gerekli olan şehir(Şehir Adı veya Plaka Kodu)", "type": "string" }, "country_code": { "description": "Sipariş adresi için gerekli olan ülke kodu", "type": "string" }, "email": { "description": "Sipariş adresi için gerekli olan e-mail adresi", "type": "string" }, "phone": { "description": "Sipariş adresi için gerekli telefon numarası", "type": "string", "example": "XXX" }, "address": { "description": "\tSipariş adresi için gerekli olan adres", "type": "string" }, "town": { "description": "Sipariş adresi için gerekli olan ilçe", "type": "string" }, "district": { "description": "Sipariş adresi için gerekli olan mahalle/cadde", "type": "string" }, "identity_number": { "description": "Sipariş adresi için gerekli olan t.c", "type": "string" } }, "type": "object" }, "items": { "properties": { "importCode": { "description": "Sipariş kalemi için gerekli olan import kodu", "type": "integer" }, "sku": { "description": "Ürünün SKU bilgisi", "type": "string" }, "qty": { "description": "Satın alınan adet", "type": "string" }, "qty_refunded": { "description": "İade adeti", "type": "string" }, "price": { "description": "Ürün fiyatı", "type": "string" }, "packageNumber": { "description": "Paket numarası", "type": "string" }, "warehouseId": { "description": "Depo id(Gebze depo için 1 gönderilmeli)", "type": "integer" }, "lineId": { "description": "HB order line id", "type": "integer" }, "hbSku": { "description": "HB Sku", "type": "string" }, "skuFifoMinDate": { "description": "Müşteri en eski sevk edilecek ürün tarihi(format: yyyyaagg)", "type": "string" }, "skuFifoMaxDate": { "description": "Müşteri en yeni sevk edilecek ürün tarihi(format: yyyyaagg)", "type": "string" }, "lineNote": { "description": "Sipariş kalem notu", "type": "string" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success or Fail message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string", "example": "OK." } }, "type": "object", "example": { "code": 200, "message": "OK" } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/api/order/cancel": { "post": { "tags": [ "Sipariş" ], "summary": "İptal Bilgisi.", "description": "Bu metod Radium'daki sipariş için iptal bilgisi gönderilmesine olanak sağlar. Bu method ile siparişin tamamı iptal edilebilir veya kalem bazlı iptal yapılabilir. Bu metod sadece statüsü open olan siparişler için geçerlidir. Not: Siparişin tamamı iptal edilecek ise shipmentPackageId bilgisinin gönderilmesi yeterli olacaktır. Kalem bazlı iptal yapılacak ise orderLineId ve quantity değerlerinin gönderilmesi gerekmektedir.", "operationId": "9c5242aecb7013dcc3c0c8956a5d4882", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "shipmentPackageId": { "description": "Sipariş id", "type": "integer", "example": "124068986" }, "orderLineId": { "description": "Sipariş satır id", "type": "integer", "example": "11650604" }, "quantity": { "description": "Kalem bazında iptal miktarı", "type": "integer", "example": "2" } }, "type": "object" } } } }, "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success or Fail message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string", "example": "OK." } }, "type": "object", "example": { "code": 200, "message": "OK" } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/api/order/order_status": { "get": { "tags": [ "Sipariş" ], "summary": "Sipariş Listeleme", "description": "Radium'a aktarılan siparişler bu servis yardımıyla listelenir.", "operationId": "6e3f96f2541a4763b48cac2c0427a191", "parameters": [ { "name": "startDate", "in": "query", "description": "Belirli bir tarihten sonraki siparişleri getirir. Y-m-d H:i:s formatta gönderilmelidir.", "required": true, "schema": { "type": "string" }, "example": "2022-07-01 00:00:00" }, { "name": "endDate", "in": "query", "description": "Belirtilen tarihe kadar olan siparişleri getirir. Y-m-d H:i:s formatta gönderilmelidir.", "required": true, "schema": { "type": "string" }, "example": "2022-12-30 00:00:00" }, { "name": "page", "in": "query", "description": "Sadece belirtilen sayfadaki bilgileri döndürür.", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "size", "in": "query", "description": "Bir sayfada listelenecek maksimum adeti belirtir.Maksimum 200", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "status", "in": "query", "description": "Siparişlerin statülerine göre bilgileri getirir.", "required": true, "schema": { "type": "string", "enum": [ "OPEN", "PICKING", "PACKING", "SHIPPING", "COMPLETED", "CANCELING", "CANCELLED", "REFUNDING", "REFUNDED", "OUT_OF_STOCK" ] }, "example": "OPEN" }, { "name": "merchantOrderNumber", "in": "query", "description": "merchantOrderNumber alanına göre siparişi getirir.", "required": false, "schema": { "type": "integer" }, "example": "12312312" } ], "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "A list with products", "content": { "application/json": { "schema": { "properties": { "totalElements": { "type": "number" }, "totalPages": { "type": "number" }, "page": { "type": "number" }, "size": { "type": "number" }, "content": { "type": "array", "items": { "properties": { "merchantOrderNumber": { "type": "string", "example": "80869231" }, "orderId": { "type": "number" }, "status": { "type": "string", "example": "OPEN" }, "lines": { "type": "array", "items": { "properties": { "merchantOrderLineNumber": { "type": "string", "example": "80869231-A" }, "orderLineId": { "type": "number" }, "quantity": { "type": "number" }, "cancelQuantity": { "type": "number" }, "shippedQuantity": { "type": "number" }, "remainQuantity": { "type": "number" } }, "type": "object" } } }, "type": "object" } } }, "type": "object", "example": { "totalElements": 1, "page": 1, "totalPages": 1, "size": 10, "content": [ { "merchantOrderNumber": "80869231", "orderId": 11650604, "status": "OPEN", "lines": [ { "merchantOrderLineNumber": "80869231-A", "orderLineId": 56040534, "quantity": 2, "cancelQuantity": 0, "shippedQuantity": 0, "remainQuantity": 2 } ] } ] } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/api/product/create_trend": { "post": { "tags": [ "Ürün" ], "summary": "Ürün Yaratma", "description": "Ürünler Radium sistemine ilk olarak bu method yardımıyla iletilecektir. Tekli ve çoklu ürün gönderimini desteklemektedir", "operationId": "e3060c2d6894a4728eaa77c3ca3e8c42", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "items": { "properties": { "stockCode": { "description": "Stok kodu", "type": "string", "example": "IphoneX" }, "categoryName": { "description": "Ürün kategori ad", "type": "string", "example": "Apple İphone Cep Telefonlar" }, "barcode": { "description": "Ürün Barkodu", "type": "string", "example": "BARCODE" }, "barcodes": { "description": "Ürün Barkodları", "type": "array", "items": {}, "example": [ "BARCODE", "BARCODE2" ] }, "listPrice": { "description": "Liste fiyatı", "type": "integer", "example": "2" }, "salePrice": { "description": "Satış Fiyatı", "type": "integer", "example": "2" }, "currencyType": { "description": "Fiyat Birimi", "type": "string", "example": "TRL" }, "vatRate": { "description": "", "type": "string", "example": "0" }, "brand": { "description": "Ürün markası.", "type": "string", "example": "xxx" }, "description": { "description": "Ürün açıklama bilgileri (HTML olabilir).", "type": "string", "example": "-" }, "attributes": { "type": "array", "items": { "properties": { "attributeName": { "description": " ", "type": "string" }, "attributeValue": { "description": " ", "type": "string" } }, "type": "object" }, "example": [ { "attributeName": "fifo", "attributeValue": "YOK" }, { "attributeName": "bozulmaSuresi", "attributeValue": 30 } ] }, "images": { "properties": { "url": { "description": "resim adresi", "type": "string" } }, "type": "object" }, "stockingAttributes": { "properties": { "shelfLifePeriod": { "description": "\tFatura adresi için gerekli olan import kodu", "type": "integer" }, "serialTracking": { "description": "Fatura adresi için gerekli olan müşteri adı", "type": "string", "example": "124068986" }, "lotTracking": { "description": "Fatura adresi için gerekli olan müşteri soyadı", "type": "string" }, "batchTracking": { "description": "Fatura adresi için gerekli olan şehir", "type": "string" }, "manufacturingDateTracking": { "description": "Fatura adresi için gerekli olan ülke kodu", "type": "string" }, "manufacturingDateFormat": { "description": "Fatura adresi için gerekli olan e-mail adresi", "type": "string", "example": "XXX" }, "expiryDateTracking": { "description": "Fatura adresi için gerekli telefon numarası", "type": "string", "example": "XXX" }, "expiryDateFormat": { "description": "\tFatura adresi için gerekli olan adres", "type": "string" }, "expiryDateTrackingMethod": { "description": "Fatura adresi için gerekli olan ilçe", "type": "string" }, "imeiTracking": { "description": "Fatura adresi için gerekli olan mahalle/cadde", "type": "string" }, "doubleImeiTracking": { "description": "Fatura adresi için gerekli olan t.c", "type": "string" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success or Fail message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string", "example": "OK." } }, "type": "object", "example": { "code": 200, "message": "OK" } } } } } }, "security": [ { "basicAuth": [] } ] } }, "/api/product/batch_request_status": { "get": { "tags": [ "Ürün" ], "summary": "İşlem Kontrolü", "description": "Bu method yardımıyla batchRequestId ile Radium'a aktarılan ürün işlemlerin sonucunun kontrolü yapılabilir.", "operationId": "d4cb22b24660cb5abac5847eff4934a0", "parameters": [ { "name": "batchRequestId", "in": "query", "description": "Servise yapılan her başarlı istek sonucunda bir adet batchRequestId bilgisi dönülmektedir.", "required": true, "schema": { "type": "integer" }, "example": "f78b8e3c-be12-4fc6-bba4-0eacda761b39" } ], "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success or Fail Message" } }, "security": [ { "basicAuth": [] } ] } }, "/api/product/stock_status_list": { "get": { "tags": [ "Ürün" ], "summary": "Stok Durum Listesi", "description": "Radium'a aktarılan ürünlerin stok durumları bu servis yardımıyla listelenir.", "operationId": "21888294fd465bd53c39faa5b522c3f2", "parameters": [ { "name": "page", "in": "query", "description": "Sadece belirtilen sayfadaki bilgileri döndürür", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "size", "in": "query", "description": "Bir sayfada listelenecek maksimum adeti belirtir.", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "sku", "in": "query", "description": "Sku bazlı filtreleme yapar.", "required": false, "schema": { "type": "string" }, "example": "10011183002" }, { "name": "barcode", "in": "query", "description": "Barkod bazlı filtreleme yapar.", "required": false, "schema": { "type": "string" } } ], "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success or Fail Message" } }, "security": [ { "basicAuth": [] } ] } }, "/api/product/check_product_exists": { "get": { "tags": [ "Ürün" ], "summary": "Ürün Varlık Kontrolü", "description": "Bu servis ile Radium'da oluşturulan ürünlerin sku veya barkod ile kontrol edilerek, eğer ürün varsa ürün idlerini dönmektedir.", "operationId": "caac16465479c17ddd43fcdd4d60c0a4", "parameters": [ { "name": "skuOrBarcodeList[]", "in": "query", "description": "Ürün Barkodları", "required": true, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "HB000005", "HBPC001", "000000010010323004" ] } ], "responses": { "200": { "description": "Success or Fail Message" } }, "security": [ { "basicAuth": [] } ] } }, "/api/transferPackage/list": { "get": { "tags": [ "Transfer Entegrasyonu" ], "summary": "Transfer Hareket Listesi", "description": "Radium içerisindeki transfer hareketleri bu servis yardımıyla listelenir. Not: start_date ve end_date parametrelerini eklemeniz halinde verilebilecek maksimum aralık bir hafta olacaktır. Tarih parametreleri olmadan package_number ile arama yapabilirsiniz. Radium ile zone entegrasyonu yapıldıktan sonra kendi zone bilgileriniz ile from_zone ve to_zone alanına istekte bulunabilirsiniz. from_zone ve to_zone parametresinin alabileceği değerleri öğrenmek için lütfen destek ekibi ile iletişime geçiniz", "operationId": "3157109845f5c14b34b84e3707a0edcd", "parameters": [ { "name": "page", "in": "query", "description": "Sadece belirtilen sayfadaki bilgileri döndürür.", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "size", "in": "query", "description": "Bir sayfada listelenecek maksimum adeti belirtir. Max 200", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "status", "in": "query", "description": "Teslimat numarasına göre filtreleme yapar.", "required": false, "schema": { "type": "string" } }, { "name": "orderNumber", "in": "query", "description": "Yapılan transferin durumu.", "required": false, "schema": { "type": "string" } }, { "name": "to_zone", "in": "query", "description": "Yapılan transferin varış yeri.", "required": false, "schema": { "type": "string" } }, { "name": "from_zone", "in": "query", "description": "Yapılan transferin başlangıç yeri.", "required": false, "schema": { "type": "string" } }, { "name": "package_number", "in": "query", "description": "Belirtilen paket numarasına uygun paket bilgisini getirir.", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Belirtilen tarihe kadar olan transfer kareketlerini getirir.", "required": true, "schema": { "type": "string" }, "example": "2022-10-13 05:21:56" }, { "name": "start_date", "in": "query", "description": "Belirli bir tarihten sonraki transfer hareketlerini getirir.", "required": true, "schema": { "type": "string" }, "example": "2022-10-11 05:21:56" } ], "responses": { "101": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 101, "message": "Auth işlemleri için gerekli parametreler eksik" } } } } }, "102": { "description": "Auth Error Message", "content": { "application/json": { "schema": { "properties": { "code": { "type": "number" }, "msg": { "type": "string" } }, "type": "object", "example": { "code": 102, "message": "Böyle bir kullanıcı yok" } } } } }, "200": { "description": "Success or Fail Message" } }, "security": [ { "basicAuth": [] } ] } } }, "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } } }