{ "openapi": "3.0.1", "info": { "title": "Jetlogi Servis", "description": "Jetlogi gönderi servisleridir.", "contact": { "name": "Jetlogi Panel", "url": "https://panel.jetlogi.com", "email": "soner.eren@bydysoft.com" }, "version": "v1" }, "paths": { "/api/ShipmentsService/Create": { "post": { "tags": [ "ShipmentsService" ], "summary": "Gönderi oluşturmak için kullanılır.", "description": "LabelFormat : \r\n \r\n Pdf = 1,\r\n Zpl = 2,\r\n \r\n\r\nShipmentChargeType : \r\n \r\n HesapSahibi = 1,\r\n Alıcı = 2,\r\n GöndericiAdresiVerilen = 3,\r\n \r\n\r\nHata Kodları :\r\n\r\n 10 = İşlem yetki hatası,\r\n 20 = Mükerrer kayıt hatası,\r\n 30 = Parametre hataları,\r\n 40 = Gönderi bulunamadı,\r\n 50 = Kullanıcı bilgi hatası,\r\n 60 = Diğer hatalar", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/APIResult" } } } } } } }, "/api/ShipmentsService/UpdateProduct": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProduct" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/APIResult" } } } } } } }, "/api/ShipmentsService/UpdateCustomerUniq": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerUniq" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/APIResult" } } } } } } }, "/api/ShipmentsService/RequiredDocumentList": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentStateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RequiredDocumentResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RequiredDocumentResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequiredDocumentResult" } } } } } } }, "/api/ShipmentsService/Update": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrder" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/APIResult" } } } } } } }, "/api/ShipmentsService/UpdateAddress": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAddress" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/APIResult" } } } } } } }, "/api/ShipmentsService/UpdateStatus": { "post": { "tags": [ "ShipmentsService" ], "summary": "Hazırlık işlemlerinin statüsünü güncelmek için kullanılır.", "description": "Kuveyt Turk HGS durum komut servisidir. Yalnizca updateBarcode Success=true sonrasinda legacy dbOrder.StatusID=152 uyumluluk durumuna gelmis kayitlarda kullanilir. StatusID=1 Dagitima cikar; StatusID=2 Imha etmeden yeniden eslestir; StatusID=5 Imha etmeden iptal et. StatusID 3 ve 4 desteklenmez.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStatus" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/APIResult" } } } } }, "x-jetlogi-status": "ACTIVE", "x-kuveyt-hgs-flow": { "lifecycle": "ACTIVE", "prerequisite": "updateBarcode Success=true", "prerequisiteLegacyDbOrderStatusId": 152, "allowedStatusIds": [ 1, 2, 5 ], "status1": "Dagitima cikar", "status2": "Imha etmeden yeniden eslestir", "status5": "Imha etmeden iptal et" } } }, "/api/ShipmentsService/ShipmentState": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentStateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ShipmentStateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentStateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentStateResult" } } } } } } }, "/api/ShipmentsService/ShipmentStatebyCustomerUniqNumber": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentStatebyCustomerUniqNumberRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ShipmentStateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentStateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentStateResult" } } } } } } }, "/api/ShipmentsService/BaseShipmentStatebyCustomerUniqNumber": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentStatebyCustomerUniqNumberRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BaseShipmentStateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BaseShipmentStateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BaseShipmentStateResult" } } } } } } }, "/api/ShipmentsService/ShipmentStatebyTransactionID": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentStatebyTransactionIDRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ShipmentStateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentStateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentStateResult" } } } } }, "x-jetlogi-status": "ACTIVE", "description": "Kuveyt Turk HGS guncel durum sorgusudur. Urun/barkod eslemesi PRODUCT_MATCHED ile 2040/2041 Onay / Onay Bekleniyor asamasina gectiginde public statusID=6020 ve fullstatuscode=6020 doner. Bu asamada legacy dbOrder.StatusID=152 yazilmaz. JetLogi updateBarcode cagrisi Kuveyt tarafinda Success=true ile kabul edildiginde HGS kart-kontrol uyumluluk durumu olarak legacy dbOrder.StatusID=152 kaydedilir ve workflow ilerler. 152 bu servisin public response status kodu degildir.", "x-kuveyt-hgs-flow": { "lifecycle": "ACTIVE", "productMatchedCanonicalStatus": 2040, "productMatchedCanonicalAltStatus": 2041, "productMatchedPublicStatusId": 6020, "productMatchedWritesLegacy152": false, "updateBarcodeBusinessSuccessField": "Success", "legacyDbOrderStatusAfterUpdateBarcodeSuccess": 152, "publicMustNotExposeLegacy152": true } } }, "/api/ShipmentsService/ShipmentCancel": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentCancel" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/APIResult" } } } } } } }, "/api/ShipmentsService/ShipmentCancelbyTransactionID": { "post": { "tags": [ "ShipmentsService" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentCancelbyTransactionID" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/APIResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/APIResult" } } } } } } } }, "components": { "schemas": { "APIResult": { "type": "object", "properties": { "statu": { "type": "boolean", "description": "Başarılı sonuçlar için \"true\" değeri alır." }, "cargoKey": { "type": "integer", "description": "Kargo takip numarası.", "format": "int32" }, "cargoUrl": { "type": "string", "description": "Kargo takip web url.", "nullable": true }, "message": { "type": "string", "description": "Hata varsa açıklaması.", "nullable": true }, "errorCode": { "type": "string", "description": "Hata varsa ilgili hata kodu döner:\r\n\u003clist type=\"bullet\"\u003e\u003citem\u003e\u003cdescription\u003e10: İşlem yetki hatası\u003c/description\u003e\u003c/item\u003e\u003citem\u003e\u003cdescription\u003e20: Mükerrer kayıt hatası\u003c/description\u003e\u003c/item\u003e\u003citem\u003e\u003cdescription\u003e30: Parametre hataları\u003c/description\u003e\u003c/item\u003e\u003citem\u003e\u003cdescription\u003e40: Gönderi bulunamadı\u003c/description\u003e\u003c/item\u003e\u003citem\u003e\u003cdescription\u003e50: Kullanıcı bilgi hatası\u003c/description\u003e\u003c/item\u003e\u003citem\u003e\u003cdescription\u003e60: Diğer hatalar\u003c/description\u003e\u003c/item\u003e\u003c/list\u003e", "nullable": true }, "barcode": { "$ref": "#/components/schemas/Barcodes" }, "returnBarcode": { "$ref": "#/components/schemas/ReturnBarcodes" } }, "additionalProperties": false }, "Authentication": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Barcodes": { "type": "object", "properties": { "zpl": { "type": "string", "description": "ZPL kod text değeri.", "nullable": true }, "content": { "type": "string", "description": "PDF barkod dosyası.", "format": "byte", "nullable": true }, "fileExtensions": { "type": "string", "description": "PDF yada ZPL değerleri alır.", "nullable": true } }, "additionalProperties": false }, "BaseShipmentStateResult": { "type": "object", "properties": { "statu": { "type": "boolean", "description": "Başarılı sonuçlar için \"true\" değeri alır." }, "cargoKey": { "type": "integer", "description": "Kargo takip numarası.", "format": "int32" }, "cargoUrl": { "type": "string", "description": "Kargo takip web url.", "nullable": true }, "message": { "type": "string", "description": "Hata varsa açıklaması.", "nullable": true }, "errorCode": { "type": "integer", "description": "Hata varsa ilgili hata kodu döner:\r\n\u003clist type=\"bullet\"\u003e\u003citem\u003e\u003cdescription\u003e10: İşlem yetki hatası\u003c/description\u003e\u003c/item\u003e\u003citem\u003e\u003cdescription\u003e20: Mükerrer kayıt hatası\u003c/description\u003e\u003c/item\u003e\u003citem\u003e\u003cdescription\u003e30: Parametre hataları\u003c/description\u003e\u003c/item\u003e\u003citem\u003e\u003cdescription\u003e40: Gönderi bulunamadı\u003c/description\u003e\u003c/item\u003e\u003citem\u003e\u003cdescription\u003e50: Kullanıcı bilgi hatası\u003c/description\u003e\u003c/item\u003e\u003citem\u003e\u003cdescription\u003e60: Diğer hatalar\u003c/description\u003e\u003c/item\u003e\u003c/list\u003e", "format": "int32", "nullable": true }, "barcode": { "$ref": "#/components/schemas/Barcodes" }, "returnBarcode": { "$ref": "#/components/schemas/ReturnBarcodes" }, "order": { "$ref": "#/components/schemas/ShipmentState" } }, "additionalProperties": false }, "LabelFormat": { "enum": [ 1, 2 ], "type": "integer", "description": "Response değerinde Etiket isteniyorsa doldurulur.", "format": "int32" }, "Package": { "type": "object", "properties": { "barcode": { "type": "string", "nullable": true }, "desi": { "type": "integer", "format": "int32" }, "kg": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RequiredDocumentResult": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/APIResult" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/RequiredFiles" }, "nullable": true } }, "additionalProperties": false }, "RequiredFiles": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "content": { "type": "string", "format": "byte", "nullable": true }, "description": { "type": "string", "nullable": true }, "docGuid": { "type": "string", "nullable": true }, "customerDocCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReturnBarcodes": { "type": "object", "properties": { "cargoKey": { "type": "integer", "description": "Kargo takip numarası.", "format": "int32" }, "cargoUrl": { "type": "string", "description": "Kargo takip web url.", "nullable": true }, "barcode": { "$ref": "#/components/schemas/Barcodes" } }, "additionalProperties": false }, "Shipment": { "required": [ "acceptorAddress", "acceptorCity", "acceptorDistrict", "acceptorGsm", "acceptorName", "auth", "customerUniqNumber", "identityNumber" ], "type": "object", "properties": { "acceptorName": { "minLength": 1, "type": "string" }, "acceptorGsm": { "minLength": 1, "type": "string" }, "identityNumber": { "minLength": 1, "type": "string" }, "acceptorAddress": { "minLength": 1, "type": "string" }, "acceptorCity": { "minLength": 1, "type": "string" }, "acceptorDistrict": { "minLength": 1, "type": "string" }, "neighborhood": { "type": "string", "nullable": true }, "customerUniqNumber": { "minLength": 1, "type": "string" }, "transactionID": { "type": "string", "nullable": true }, "shipFromAddress": { "$ref": "#/components/schemas/shipFromAddress" }, "additionalDescription": { "type": "string", "nullable": true }, "packages": { "type": "array", "items": { "$ref": "#/components/schemas/Package" }, "nullable": true }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/shipDocument" }, "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/shipProduct" }, "nullable": true }, "additionalData": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "shipmentChargeType": { "$ref": "#/components/schemas/ShipmentChargeType" }, "contractID": { "type": "integer", "description": "Özel işlemlerde kullanılır İade toplama gibi.", "format": "int32", "nullable": true }, "labelFormat": { "$ref": "#/components/schemas/labelInfo" }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "ShipmentCancel": { "type": "object", "properties": { "cargokey": { "type": "integer", "format": "int32" }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "ShipmentCancelbyTransactionID": { "type": "object", "properties": { "transactionID": { "type": "string", "nullable": true }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "ShipmentChargeType": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "Fatura edilecek cari hesabı belirler.", "format": "int32" }, "ShipmentState": { "required": [ "customerUniqNumber" ], "type": "object", "properties": { "cargokey": { "type": "integer", "format": "int32" }, "acceptorName": { "type": "string", "nullable": true }, "customerUniqNumber": { "minLength": 1, "type": "string" }, "transactionID": { "type": "string", "nullable": true }, "outputNumber": { "type": "string", "nullable": true }, "statusID": { "type": "string", "nullable": true }, "statusName": { "type": "string", "nullable": true }, "fullstatuscode": { "type": "string", "nullable": true }, "fullstatusname": { "type": "string", "nullable": true }, "internalStatusID": { "type": "integer", "format": "int32", "nullable": true }, "internalStatusName": { "type": "string", "nullable": true }, "deliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "appointmentDate": { "type": "string", "format": "date-time", "nullable": true }, "recipient": { "type": "string", "nullable": true }, "reasoncode": { "type": "integer", "format": "int32", "nullable": true }, "reasonname": { "type": "string", "nullable": true }, "pruductnumber": { "type": "string", "nullable": true }, "stateHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentStateHistory" }, "nullable": true } }, "additionalProperties": false }, "ShipmentStateHistory": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "nullable": true }, "statusID": { "type": "integer", "format": "int32", "nullable": true }, "statusName": { "type": "string", "nullable": true }, "fullStatusCode": { "type": "string", "nullable": true }, "fullstatusName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShipmentStateRequest": { "type": "object", "properties": { "cargokey": { "type": "integer", "format": "int32" }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "ShipmentStateResult": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/APIResult" }, "order": { "$ref": "#/components/schemas/ShipmentState" } }, "additionalProperties": false }, "ShipmentStatebyCustomerUniqNumberRequest": { "type": "object", "properties": { "customerUniqNumber": { "type": "string", "nullable": true }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "ShipmentStatebyTransactionIDRequest": { "type": "object", "properties": { "transactionID": { "type": "string", "nullable": true }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "UpdateAddress": { "required": [ "auth", "transactionID" ], "type": "object", "properties": { "transactionID": { "minLength": 1, "type": "string" }, "branchCode": { "type": "string", "nullable": true }, "acceptorAddress": { "type": "string", "nullable": true }, "acceptorCity": { "type": "string", "nullable": true }, "acceptorDistrict": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "UpdateCustomerUniq": { "required": [ "auth", "changeuniqnumber", "uniqnumber" ], "type": "object", "properties": { "uniqnumber": { "minLength": 1, "type": "string" }, "changeuniqnumber": { "minLength": 1, "type": "string" }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "UpdateOrder": { "required": [ "acceptorAddress", "acceptorCity", "acceptorDistrict", "auth", "transactionID" ], "type": "object", "properties": { "transactionID": { "minLength": 1, "type": "string" }, "acceptorName": { "type": "string", "nullable": true }, "acceptorSurName": { "type": "string", "nullable": true }, "acceptorGSM": { "type": "string", "nullable": true }, "acceptorAddress": { "minLength": 1, "type": "string" }, "acceptorCity": { "minLength": 1, "type": "string" }, "acceptorDistrict": { "minLength": 1, "type": "string" }, "neighborhood": { "type": "string", "nullable": true }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "UpdateProduct": { "required": [ "auth", "cargoKey" ], "type": "object", "properties": { "cargoKey": { "type": "integer", "format": "int32" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/shipProduct" }, "nullable": true }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "UpdateStatus": { "required": [ "auth", "statusID", "transactionID" ], "type": "object", "properties": { "transactionID": { "minLength": 1, "type": "string" }, "statusID": { "type": "integer", "format": "int32" }, "auth": { "$ref": "#/components/schemas/Authentication" } }, "additionalProperties": false }, "labelInfo": { "type": "object", "properties": { "retunLabel": { "type": "boolean", "description": "İade ile ilgli hazır etiket basmak için \"true\" değeri verilmeli.", "nullable": true }, "labelFormat": { "$ref": "#/components/schemas/LabelFormat" } }, "additionalProperties": false }, "shipDocument": { "type": "object", "properties": { "docName": { "type": "string", "nullable": true }, "docBarcode": { "type": "string", "nullable": true }, "content": { "type": "string", "description": "PDF formatındaki dosya.", "format": "byte", "nullable": true } }, "additionalProperties": false }, "shipFromAddress": { "type": "object", "properties": { "shipFromCompany": { "type": "string", "description": "Alım adresi farklı oldugunda doldurulur.", "nullable": true }, "shipFromName": { "type": "string", "nullable": true }, "shipFromTaxnumber": { "type": "string", "nullable": true }, "shipFromTaxoffice": { "type": "string", "nullable": true }, "shipFromAddressLine": { "type": "string", "nullable": true }, "shipFromCity": { "type": "string", "nullable": true }, "shipFromDistrict": { "type": "string", "nullable": true } }, "additionalProperties": false }, "shipProduct": { "type": "object", "properties": { "prodName": { "type": "string", "nullable": true }, "prodBarcode": { "type": "string", "description": "Ürünün tipini belirleyen barkod.", "nullable": true } }, "additionalProperties": false } } } }