İrsaliye Oluşturma

Önemli Bilgi

İrsaliye resmi olarak gönderilene kadar tarafınızdan gönderilen body.document.External.ID ve body.document.External.Type ile takip edilmektedir. Bu iki bilgi birlikte benzersiz olmalıdır.

Örnek olarak ID: 1234 ve Type: Müthiş Entegre App olarak irsaliye oluşturulduğunda, tekrar bu iki değer gönderilerek başka bir irsaliye oluşturulamaz.

TIP

Önerilen kullanım şekli olarak Type bilgisini sabit tutup, ID bilgisini değiştirilerek gönderilmesidir. Çünkü Type bilgisi belge uygulaması üzerinde gözükmektedir ve buradan filtrelemeler yapılabilmektedir.

INFO

Eğer uygulamanızda dönem vs. gibi IDnin tekrar etmesini zorunlu kılan durumlar bulunuyor ise Type bilgisini Müthiş Entegre App:{dönem} şeklinde gönderebilirsiniz. Bu kullanımda farklı dönemler içerisinde aynı ID ile gönderilmiş olan belgeler çakışmayacaktır ve daha stabil bir kullanım sunulmuş olacaktır.

💡

Ayrıca Type bilgisi : işareti ile parse edilmektedir. Yani Müthiş Entegre App:{dönem} kullanımında belge uygulaması üzerinde sadece Müthiş Entegre App yazısı gözükecektir. Dönemin de gözükmesini isterseniz Müthiş Entegre App {dönem} gibi bir kullanım sağlayabilirsiniz.

DANGER

İrsaliye oluşturulduktan sonra response olarak dönen UUID bilgisini KESİNLİKLE saklayınız. Bu bilgi Dışarı Aktarma, İptal etme gibi resmi olan endpoinlerde talep edilecektir.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

draft

boolean

optional

İrsaliyenin taslaklara mı yoksa doğrudan gönderim mi sağlanacağının bilgisi

Default:

true

document

object

required

İrsaliye Bilgisi

External

object

required

Entegre uygulama bilgileri

NumberOrSerie

optional

İrsaliye Seri veya Numarası (Gönderilmez ise portalda tanımlanan varsayılan serileri alır)

UUID

string <uuid>

optional

İrsaliye UUID bilgisi (Gönderilmez ise otomatik alır ve Response olarak UUID bilgisi döner)

IssueDateTime

string

required

İrsaliye Tarih ve Saat Bilgisi (YYYY-MM-DDTHH:mm:ss formatında gönderilmelidir)

Notes

array[string]

optional

İrsaliye notları

Order

object

optional

Sipariş bilgisi

Customer

object

required

Alıcı Bilgileri

BuyerCustomer

object

optional

Satın Alan Taraf Bilgileri

SellerSupplier

object

optional

Malları Sağlayan Taraf Bilgileri

OriginatorCustomer

object

optional

Malların Alınmasını Sağlayan Taraf Bilgileri

Shipment

object

optional

Teslimat Detayları

Lines

array [object {5}]

required

İrsaliye Kalemleri

>= 1 items

Example

{
  "draft": true,
  "document": {
    "External": {
      "ID": "string",
      "RefNo": "MEA11152",
      "Type": "Müthiş Entegre App"
    },
    "NumberOrSerie": "RS",
    "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
    "IssueDateTime": "string",
    "Notes": [
      "string"
    ],
    "Order": {
      "Date": "2023-10-19",
      "Value": "SIP0001"
    },
    "Customer": {
      "TaxNumber": "string",
      "TaxOffice": "string",
      "Name": "string",
      "Address": "string",
      "District": "string",
      "City": "string",
      "Country": "string",
      "PostalCode": "strin",
      "Phone": "string",
      "Fax": "string",
      "Mail": "string",
      "Website": "string"
    },
    "BuyerCustomer": {
      "TaxNumber": "string",
      "TaxOffice": "string",
      "Name": "string",
      "Address": "string",
      "District": "string",
      "City": "string",
      "Country": "string",
      "PostalCode": "strin",
      "Phone": "string",
      "Fax": "string",
      "Mail": "string",
      "Website": "string"
    },
    "SellerSupplier": {
      "TaxNumber": "string",
      "TaxOffice": "string",
      "Name": "string",
      "Address": "string",
      "District": "string",
      "City": "string",
      "Country": "string",
      "PostalCode": "strin",
      "Phone": "string",
      "Fax": "string",
      "Mail": "string",
      "Website": "string"
    },
    "OriginatorCustomer": {
      "TaxNumber": "string",
      "TaxOffice": "string",
      "Name": "string",
      "Address": "string",
      "District": "string",
      "City": "string",
      "Country": "string",
      "PostalCode": "strin",
      "Phone": "string",
      "Fax": "string",
      "Mail": "string",
      "Website": "string"
    },
    "Shipment": {
      "Driver": {
        "Name": "string",
        "Surname": "string",
        "ID": "12345678901"
      },
      "Carrier": {
        "TaxNumber": "string",
        "Name": "string",
        "Address": "string",
        "District": "string",
        "City": "string",
        "Country": "string",
        "PostalCode": "strin"
      },
      "Delivery": {
        "ActualDateTime": "string",
        "Address": {
          "Address": "string",
          "District": "string",
          "City": "string",
          "Country": "string",
          "PostalCode": "string"
        }
      }
    },
    "Lines": [
      {
        "Name": "Örnek mal hizmet adı",
        "Quantity": 19.1,
        "UnitCode": "ADET",
        "Price": 19.05,
        "AdditionalNames": {
          "Description": "string",
          "Brand": "string",
          "Model": "string",
          "BuyerCode": "string",
          "SellerCode": "string",
          "ManufacturerCode": "string",
          "Origin": "string",
          "Note": "string"
        }
      }
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apidemo.rahatsistem.com.tr/v2/documents/despatch.create' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "draft": true,
    "document": {
        "External": {
            "ID": "string",
            "RefNo": "MEA11152",
            "Type": "Müthiş Entegre App"
        },
        "NumberOrSerie": "RS",
        "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
        "IssueDateTime": "string",
        "Notes": [
            "string"
        ],
        "Order": {
            "Date": "2023-10-19",
            "Value": "SIP0001"
        },
        "Customer": {
            "TaxNumber": "string",
            "TaxOffice": "string",
            "Name": "string",
            "Address": "string",
            "District": "string",
            "City": "string",
            "Country": "string",
            "PostalCode": "strin",
            "Phone": "string",
            "Fax": "string",
            "Mail": "string",
            "Website": "string"
        },
        "BuyerCustomer": {
            "TaxNumber": "string",
            "TaxOffice": "string",
            "Name": "string",
            "Address": "string",
            "District": "string",
            "City": "string",
            "Country": "string",
            "PostalCode": "strin",
            "Phone": "string",
            "Fax": "string",
            "Mail": "string",
            "Website": "string"
        },
        "SellerSupplier": {
            "TaxNumber": "string",
            "TaxOffice": "string",
            "Name": "string",
            "Address": "string",
            "District": "string",
            "City": "string",
            "Country": "string",
            "PostalCode": "strin",
            "Phone": "string",
            "Fax": "string",
            "Mail": "string",
            "Website": "string"
        },
        "OriginatorCustomer": {
            "TaxNumber": "string",
            "TaxOffice": "string",
            "Name": "string",
            "Address": "string",
            "District": "string",
            "City": "string",
            "Country": "string",
            "PostalCode": "strin",
            "Phone": "string",
            "Fax": "string",
            "Mail": "string",
            "Website": "string"
        },
        "Shipment": {
            "Driver": {
                "Name": "string",
                "Surname": "string",
                "ID": "12345678901"
            },
            "Carrier": {
                "TaxNumber": "string",
                "Name": "string",
                "Address": "string",
                "District": "string",
                "City": "string",
                "Country": "string",
                "PostalCode": "strin"
            },
            "Delivery": {
                "ActualDateTime": "string",
                "Address": {
                    "Address": "string",
                    "District": "string",
                    "City": "string",
                    "Country": "string",
                    "PostalCode": "string"
                }
            }
        },
        "Lines": [
            {
                "Name": "Örnek mal hizmet adı",
                "Quantity": 19.1,
                "UnitCode": "ADET",
                "Price": 19.05,
                "AdditionalNames": {
                    "Description": "string",
                    "Brand": "string",
                    "Model": "string",
                    "BuyerCode": "string",
                    "SellerCode": "string",
                    "ManufacturerCode": "string",
                    "Origin": "string",
                    "Note": "string"
                }
            }
        ]
    }
}'

Responses

🟢201Created

application/json

Body

data

object

required

İstek sonucunda dönülmesi gereken bir şey varsa data objesi altında döner

uuid

string <uuid>

required

Gönderdiğiniz veya otomatik oluşturulan irsaliye UUIDsi (Bu bilgiyi SAKLAYINIZ. Daha sonraki isteklerde gerekli olacak)

warns

array[string]

required

İrsaliye ile ilgili verilmesi gereken bilgiler

Example

{
  "data": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "warns": [
      "string"
    ]
  }
}

🟠400Bad Request

Önemli Bilgi#

Request

Request samples

Responses

Önemli Bilgi