BerandaUntuk penyedia logistik Kesalahan API

Kesalahan API

Pahami dan selesaikan kesalahan yang dikembalikan oleh Zonos GraphQL API.

GraphQL

Zonos API mengembalikan dua jenis kesalahan: kode status HTTP untuk kegagalan tingkat transportasi, dan kesalahan GraphQL untuk masalah tingkat aplikasi. Sebagian besar kesalahan adalah kesalahan GraphQL yang mencakup klasifikasi di bidang extensions untuk membantu mengidentifikasi penyebab dan resolusi yang sesuai.

Kode status HTTP

Kesalahan HTTP dikembalikan ketika permintaan tidak dapat diproses pada tingkat transportasi.

Kode status↕	Arti↕
400	Argumen tidak valid / permintaan buruk — permintaan berisi masukan yang tidak valid.
401	Tidak sah — tidak ada kredensial valid yang diberikan.
404	Tidak ditemukan — sumber daya yang diminta tidak ada.
409	Konflik sumber daya — permintaan bertentangan dengan status sumber daya saat ini.
412	Kondisi awal gagal — kondisi yang diperlukan tidak terpenuhi sebelum pemrosesan.
422	Entitas yang tidak dapat diproses — isi permintaan secara struktural valid tetapi berisi nilai yang tidak valid.
429	Tingkat dibatasi — terlalu banyak permintaan dalam waktu singkat. Gunakan backoff eksponensial dan coba lagi.
500	Kesalahan server internal — kegagalan sisi server yang tidak terduga terjadi. Coba lagi; hubungi dukungan jika berkelanjutan.
503	Layanan tidak tersedia — layanan sedang offline sementara. Coba lagi setelah penundaan singkat.
504	Timeout — server tidak menerima respons tepat waktu. Coba lagi permintaan.

Format kesalahan GraphQL

Kesalahan tingkat aplikasi dikembalikan sebagai daftar di bidang errors dari isi respons. Setiap kesalahan mencakup message, path operasi yang gagal, dan objek extensions dengan tipe kesalahan dan ID permintaan.

1{

2 "errors": [

3 {

4 "message": "Description of the error",

5 "path": [

6 "landedCostCalculate"

7 ],

8 "extensions": {

9 "errorType": "BAD_REQUEST",

10 "requestId": "req_abc123"

11 }

12 }

13 ]

14}

Klasifikasi kesalahan

Bidang extensions.errorType menunjukkan kategori kesalahan dan tindakan yang disarankan.

Klasifikasi↕	Setara HTTP↕	Arti↕	Tindakan↕
`BAD_REQUEST`	400	Masukan atau parameter permintaan tidak valid.	Perbaiki permintaan — periksa bidang yang diperlukan, format, dan nilai.
`NOT_FOUND`	404	Sumber daya yang direferensikan tidak ada.	Verifikasi ID, kode, dan bahwa default yang diperlukan dikonfigurasi.
`UNAVAILABLE`	503	Layanan atau opsi yang diminta tidak tersedia untuk rute ini.	Coba metode, tingkat layanan, atau tujuan yang berbeda.
`PERMISSION_DENIED`	401 / 403	Kegagalan autentikasi atau otorisasi.	Periksa kredensial dan izin akun.
`FAILED_PRECONDITION`	412	Kondisi konfigurasi atau pengaturan yang diperlukan tidak terpenuhi.	Periksa pengaturan organisasi atau hubungi dukungan.
`INTERNAL`	500	Kegagalan sisi server yang tidak terduga terjadi.	Coba lagi permintaan; hubungi dukungan jika masalah berlanjut.
`UNKNOWN`	500	Kesalahan yang tidak terduga tanpa klasifikasi lebih lanjut.	Verifikasi format permintaan; hubungi dukungan jika masalah berlanjut.

Pesan demo

Kesalahan API

Kode status HTTP

Format kesalahan GraphQL

Klasifikasi kesalahan

Apakah halaman ini bermanfaat?