İrsaliye Listeleme

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Body Params application/json

query

object

required

Filtre Objesi

direction

enum<string>

optional

Giden irsaliyeleri listelemek için out, gelen irsaliyeleri listelemek için in bilgisi girilecektir

Allowed values:

inout

startDate

string

required

İrsaliye listesinin hangi tarihten itibaren listeleneceği (YYYY-MM-DD formatında gönderilmeli)

endDate

string

required

İrsliye listesinin hangi tarihe kadar listeneceği (YYYY-MM-DD formatında gönderilmeli)

sortBy

enum<string>

optional

Bu bilgi listelemede hangi tarihin baz alınacağı bilgisidir

Allowed values:

received_atissue_date

Default:

issue_date

sortDefs

array [object {2}]

optional

Listenin hangi bilgi ile sıralanacağının bilgisini içerir

Default:

{"field":"issue_date","direction":"asc"}

search

string | null

optional

Kelime ile arama filtresi

<= 250 characters

pageSize

integer

optional

Sayfanın kaç İrsaliye içereceği bilgisi

>= 1<= 100

Default:

10

page

integer

optional

Kaçıncı sayfanın talep edildiğinin bilgisi

>= 1

Default:

1

statusCodes

array[number]

optional

İrsaliyeleri durum koduna göre filtrelemek için kullanılır (Geçerli kodlar için listeleye bakınız)

Allowed values:

201220012002200320004000

replyStatusCodes

array[number]

optional

İrsaliyeleri yanıt durumlarına göre filtremek için kullanılır (Geçerli kodlar için listeye bakınız)

Allowed values:

20042010

includeErp

boolean

optional

Erp işareti konulmuş belgeleri ayrımak için kullanılır

printed

boolean

optional

Yazdırıldı işareti konulmuş belgeleri ayırmak için kullanılır

readMarked

boolean

optional

Okundu işareti konulmuş belgeleri ayırma için kullanılır

Example

{
  "query": {
    "direction": "in",
    "startDate": "string",
    "endDate": "string",
    "sortBy": "issue_date",
    "sortDefs": [
      {
        "field": "issue_date",
        "direction": "asc"
      }
    ],
    "search": "string",
    "pageSize": 10,
    "page": 1,
    "statusCodes": [
      2012
    ],
    "replyStatusCodes": [
      2004
    ],
    "includeErp": true,
    "printed": true,
    "readMarked": true
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apidemo.rahatsistem.com.tr/v2/documents/despatch.list' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "query": {
        "direction": "in",
        "startDate": "string",
        "endDate": "string",
        "sortBy": "issue_date",
        "sortDefs": [
            {
                "field": "issue_date",
                "direction": "asc"
            }
        ],
        "search": "string",
        "pageSize": 10,
        "page": 1,
        "statusCodes": [
            2012
        ],
        "replyStatusCodes": [
            2004
        ],
        "includeErp": true,
        "printed": true,
        "readMarked": true
    }
}'

Responses

🟢200OK

application/json

Body

data

object

required

pagination

object

required

items

array [object {19}]

required

İrsaliye listesi

Example

{
  "data": {
    "pagination": {
      "count": 0,
      "count_unfiltered": 0,
      "page_size": 0,
      "page_index": 0
    },
    "items": [
      {
        "integrator": "string",
        "uuid": "string",
        "id": "string",
        "profile_id": "string",
        "type_code": "string",
        "issue_date": "string",
        "issue_time": "string",
        "currency": "string",
        "note": "string",
        "notes": [
          "string"
        ],
        "sender": {
          "name": "string",
          "vkn_tckn": "string",
          "city": "string",
          "city_subdivision": "string",
          "tax_office": "string",
          "email": "string"
        },
        "receiver": {
          "name": "string",
          "vkn_tckn": "string",
          "city": "string",
          "city_subdivision": "string",
          "email": "string"
        },
        "received_at": "string",
        "is_archived": true,
        "is_printed": true,
        "status": {
          "summary": "string",
          "status_code": 0,
          "status": "string",
          "gib_status_code": 0,
          "message": "string",
          "progress": {
            "step": 0,
            "step_count": 0,
            "percentage": 0
          }
        },
        "short_id": "string",
        "app_name": null,
        "lines": [
          {
            "id": "string",
            "name": "string",
            "quantity": 0,
            "quantity_unit": "string",
            "price": 0,
            "price_currency": "string",
            "extension_amount": 0,
            "extension_amount_currency": "string"
          }
        ]
      }
    ]
  }
}

🟠400Bad Request

Açıklama#

Request

Request samples

Responses

Açıklama