> ## Documentation Index > Fetch the complete documentation index at: https://apidocs.noyax.com/llms.txt > Use this file to discover all available pages before exploring further. # Sevkiyat tanımı detayı > Tek bir sevkiyat tanımı kaydını getirir. ## OpenAPI ````yaml api-reference/openapi.tr.json GET /api/v1/definitions/shipment-definitions/{shipmentDefinitionId} openapi: 3.1.1 info: title: Noyax API description: Server-to-server API for integrations to access Noyax data. version: '1.0' servers: - url: https://api.noyax.com security: - Bearer: [] tags: - name: Sections - name: Warehouses - name: Product Critical Stock - name: Product groups - name: Product Parameter Definitions - name: Product Parameters - name: Product Prices - name: Products - name: Cities - name: Countries - name: Currencies - name: Districts - name: Shipment Definitions - name: Units - name: VAT rates - name: Customer Addresses - name: Customer Bank Accounts - name: Customer Definitions - name: Customer Group Members - name: Customer Links - name: Customer Parameters - name: Customer Representatives - name: Customers - name: Customer Statement - name: Customer Telephones paths: /api/v1/definitions/shipment-definitions/{shipmentDefinitionId}: get: tags: - Shipment Definitions summary: Sevkiyat tanımı detayı parameters: - name: shipmentDefinitionId in: path description: Sevkiyat tanımı ID'si. required: true schema: type: string format: uuid - name: X-UserID in: header description: >- İsteğin adına yapıldığı Noyax kullanıcısının ID'si. Oluşturulan, güncellenen ve silinen kayıtların denetim alanlarına yazılır. required: true schema: minimum: 1 type: integer format: int32 - name: X-CompanyID in: header description: >- Şirketin ID'si. Kullanıcı bu şirkete tanımlı olmalıdır. Bütün okuma ve yazma işlemleri bu şirketle sınırlıdır. required: true schema: minimum: 1 type: integer format: int32 - name: X-PeriodID in: header description: >- Muhasebe döneminin ID'si. Cari endpoint'lerinde isteğe bağlıdır; gönderilirse oluşturulan kayıtlara yazılır. schema: minimum: 1 type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DataResultOfShipmentDefinitionDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResult' example: Success: false ResultCode: '0201' Message: X-UserID header is required. Errors: - Code: '0201' Message: X-UserID header is required. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResult' example: Success: false ResultCode: '0102' Message: Token has expired. Obtain a new token using the refresh token. Errors: - Code: '0102' Message: >- Token has expired. Obtain a new token using the refresh token. '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResult' example: Success: false ResultCode: '0110' Message: You do not have permission for this operation. Errors: - Code: '0110' Message: You do not have permission for this operation. '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResult' example: Success: false ResultCode: '0530' Message: Shipment definition not found. Errors: - Code: '0530' Message: Shipment definition not found. '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErrorResult' example: Success: false ResultCode: '0120' Message: Daily request limit (10000) exceeded. Errors: - Code: '0120' Message: Daily request limit (10000) exceeded. components: schemas: DataResultOfShipmentDefinitionDto: required: - Success - ResultCode - Data type: object properties: Success: type: boolean description: İşlemin başarılı olup olmadığı. example: true ResultCode: type: string description: >- Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors içinde listelenir. example: '0000' Message: type: - 'null' - string description: >- Success false olduğunda hata mesajı. Bütün hataların mesajları tek metinde birleştirilir. Data: $ref: '#/components/schemas/ShipmentDefinitionDto' ErrorResult: type: object properties: Success: type: boolean description: İşlemin başarılı olup olmadığı. example: false ResultCode: type: - 'null' - string description: >- Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors içinde listelenir. Message: type: - 'null' - string description: >- Success false olduğunda hata mesajı. Bütün hataların mesajları tek metinde birleştirilir. Errors: type: - 'null' - array items: $ref: '#/components/schemas/ResultError' description: >- Kodlarıyla birlikte bütün hatalar. Yalnızca Success false olduğunda bulunur. ShipmentDefinitionDto: type: object properties: Id: type: string description: >- Sevkiyat tanımı ID'si. Caride ShipmentDefinitionId alanında kullanılır. format: uuid Code: type: - 'null' - string description: >- Zorunlu. Sevkiyat kodu, şirket içinde benzersiz olmalıdır. En fazla 50 karakter. example: '5469' Description: type: - 'null' - string description: Açıklama. En fazla 255 karakter. example: Istanbul road shipments TransportMode: type: integer description: >- Zorunlu. 1: Karayolu, 2: Demiryolu, 3: Denizyolu, 4: Havayolu. TransportInfo1 ve TransportInfo2 alanlarının anlamını belirler. format: int32 example: 1 TransportInfo1: type: - 'null' - string description: >- Zorunlu. Taşıma şekline göre araç bilgisi: 1 plaka, 2 tren numarası, 3 gemi adı, 4 uçak numarası. En fazla 50 karakter. example: 34ABC123 TransportInfo2: type: - 'null' - string description: >- İkinci taşıma bilgisi; yalnızca TransportMode 2 (vagon numarası) ya da 3 (IMO numarası) iken kullanılır. 1 (karayolu) ve 4 (havayolu) için kaydedilmez. En fazla 50 karakter. CarrierName: type: - 'null' - string description: >- Taşıyıcı firma adı. Sevkiyat taşıyıcı firmayla yapılıyorsa diğer Carrier* alanlarıyla birlikte zorunludur; kendi aracınız için hepsini boş bırakın. En fazla 75 karakter. example: Example Logistics Ltd. CarrierTaxNumber: type: - 'null' - string description: Taşıyıcı firmanın vergi numarası. En fazla 50 karakter. example: '1234567890' CarrierCity: type: - 'null' - string description: Taşıyıcı firmanın ili. En fazla 50 karakter. example: ISTANBUL CarrierDistrict: type: - 'null' - string description: Taşıyıcı firmanın ilçesi. En fazla 50 karakter. example: KADIKÖY CarrierCountry: type: - 'null' - string description: Taşıyıcı firmanın ülkesi. En fazla 50 karakter. example: TÜRKİYE Driver1FirstName: type: - 'null' - string description: >- 1. sürücünün adı. Taşıyıcı firma yoksa zorunludur. Taşıyıcı firma varsa kaydedilmez. En fazla 50 karakter. example: Ahmet Driver1LastName: type: - 'null' - string description: >- 1. sürücünün soyadı. Taşıyıcı firma yoksa zorunludur. En fazla 20 karakter. example: Kaya Driver1IdentityNumber: type: - 'null' - string description: >- 1. sürücünün T.C. kimlik numarası. Taşıyıcı firma yoksa zorunludur. En fazla 20 karakter. example: '12345678901' Driver2FirstName: type: - 'null' - string description: 2. sürücünün adı. En fazla 50 karakter. Driver2LastName: type: - 'null' - string description: 2. sürücünün soyadı. En fazla 20 karakter. Driver2IdentityNumber: type: - 'null' - string description: 2. sürücünün T.C. kimlik numarası. En fazla 20 karakter. TrailerPlate1: type: - 'null' - string description: >- Dorse plakası 1. Yalnızca TransportMode 1 (karayolu) ve taşıyıcı firma yokken kaydedilir. En fazla 20 karakter. example: 34ABC123 TrailerPlate2: type: - 'null' - string description: >- Dorse plakası 2. Yalnızca TransportMode 1 (karayolu) ve taşıyıcı firma yokken kaydedilir. En fazla 20 karakter. ResultError: required: - Code - Message type: object properties: Code: type: string description: Hata kodu. Tam liste için sonuç kodları sayfasına bakın. Message: type: string description: Hata açıklaması. securitySchemes: Bearer: type: http description: Access token obtained from the Noyax auth service with your API key. scheme: bearer bearerFormat: JWT ````