Response Schemas¶
integrify.ecustoms.schemas.response.ExceptionSchema
pydantic-model
¶
Bases: BaseSchema
Xəta məlumatları
Fields:
-
status(str | None) -
code(str | None) -
error_message(Any) -
validation_error(Any) -
error_params(list[str] | None)
status = None
pydantic-field
¶
Xəta növü: error, warn, info (bax: ExceptionStatus)
code = None
pydantic-field
¶
Xəta kodu
error_message = None
pydantic-field
¶
Xəta mesajı
validation_error = None
pydantic-field
¶
Validasiya mesajı
error_params = None
pydantic-field
¶
Xəta parametrləri
error_code
property
¶
code-un ResponseCode qarşılığı; tanınmayan kod üçün None
model_config = ConfigDict(populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
integrify.ecustoms.schemas.response.BaseResponseSchema
pydantic-model
¶
Bases: BaseSchema
Məlumat dəyişdirən sorğuların standart cavabı
Fields:
-
code(int | None) -
data(Any) -
exception(ExceptionSchema | None)
code = None
pydantic-field
¶
Servis uğurlu olduqda 200, digər bütün hallarda 0-dan fərqli bir dəyər olacaq
data = None
pydantic-field
¶
Servis uğurlu olduqda məlumat, digər bütün hallarda None olacaq
exception = None
pydantic-field
¶
Xəta baş verdikdə xətanın detalları
error_code
property
¶
code-un ResponseCode qarşılığı; tanınmayan kod üçün None
model_config = ConfigDict(populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
integrify.ecustoms.schemas.response.CarriersGoodsSchema
pydantic-model
¶
integrify.ecustoms.schemas.response.CarriersFullDataSchema
pydantic-model
¶
Bases: BaseSchema
Daşıyıcı şirkətin əlavə etdiyi bağlamanın tam məlumatları
Fields:
-
id(str | None) -
direction(str | None) -
tracking_no(str | None) -
transport_costs(str | None) -
weight_goods(str | None) -
quantity_of_goods(str | None) -
invoice_price(str | None) -
currency_type(str | None) -
invoice_azn(str | None) -
invoice_usd(str | None) -
document_type(str | None) -
fin(str | None) -
voen(str | None) -
import_name(str | None) -
import_address(str | None) -
phone(str | None) -
export_name(str | None) -
export_address(str | None) -
goods_traffic_from(str | None) -
goods_traffic_to(str | None) -
insert_date(str | None) -
airwaybill(str | None) -
depesh_number(str | None) -
depesh_date(str | None) -
status(str | None) -
ecom_reg_number(str | None) -
package_type(str | None) -
shop_type(str | None) -
goods_list(list[CarriersGoodsSchema] | None)
id = None
pydantic-field
¶
Bağlamanın unikal ID kodu
direction = None
pydantic-field
¶
Bağlamanın istiqaməti (bax: Direction)
tracking_no = None
pydantic-field
¶
Bağlamanın Track ID-si
transport_costs = None
pydantic-field
¶
Bağlamanın daşınma xərcləri
weight_goods = None
pydantic-field
¶
Bağlamanın çəkisi
quantity_of_goods = None
pydantic-field
¶
Bağlamanın sayı
invoice_price = None
pydantic-field
¶
Bağlamanın dəyəri (original)
currency_type = None
pydantic-field
¶
Bağlamanın original dəyərinin daxil edildiyi valyuta
invoice_azn = None
pydantic-field
¶
Bağlamanın dəyəri (AZN)
invoice_usd = None
pydantic-field
¶
Bağlamanın dəyəri (USD)
document_type = None
pydantic-field
¶
Bağlama sahibinin sənədinin tipi (bax: DocumentType)
fin = None
pydantic-field
¶
Bağlama sahibinin FİN kodu
voen = None
pydantic-field
¶
Şirkətin VÖEN-i
import_name = None
pydantic-field
¶
Bağlama sahibinin adı
import_address = None
pydantic-field
¶
Bağlama sahibinin ünvanı
phone = None
pydantic-field
¶
Bağlama sahibinin telefon nömrəsi
export_name = None
pydantic-field
¶
Malın alış ünvanı və ya göndərən
export_address = None
pydantic-field
¶
Göndərənin ünvanı
goods_traffic_from = None
pydantic-field
¶
Bağlamanın çıxış ölkəsi
goods_traffic_to = None
pydantic-field
¶
Bağlamanın giriş ölkəsi
insert_date = None
pydantic-field
¶
Bağlamanın əlavə edilmə tarixi
airwaybill = None
pydantic-field
¶
Aviaqaimə nömrəsi
depesh_number = None
pydantic-field
¶
Bağlamanın depeş nömrəsi
depesh_date = None
pydantic-field
¶
Depeş sorğusunun göndərilmə tarixi
status = None
pydantic-field
¶
Bağlamanın statusu (bax: PackageStatus)
ecom_reg_number = None
pydantic-field
¶
Bağlamaya yazılan bəyannamənin nömrəsi
package_type = None
pydantic-field
¶
Bağlamanın tipi (bax: PackageType)
shop_type = None
pydantic-field
¶
Mağazanın tipi
goods_list = None
pydantic-field
¶
Bağlamadakı mallar
model_config = ConfigDict(populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
integrify.ecustoms.schemas.response.CarriersDepeshInfoSchema
pydantic-model
¶
Bases: BaseSchema
Aviaqaimə üzrə depeş göndərilmiş bağlamanın məlumatları
Fields:
-
tracking_no(str | None) -
weight_of_goods(float | None) -
airwaybill(str | None) -
depesh_number(str | None) -
depesh_date(str | None)
tracking_no = None
pydantic-field
¶
Bağlamanın Track ID-si
weight_of_goods = None
pydantic-field
¶
Bağlamanın çəkisi
airwaybill = None
pydantic-field
¶
Aviaqaimə nömrəsi
depesh_number = None
pydantic-field
¶
Depeş nömrəsi
depesh_date = None
pydantic-field
¶
Depeş sorğusunun göndərilmə tarixi
model_config = ConfigDict(populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
integrify.ecustoms.schemas.response.OperationSchema
pydantic-model
¶
Bases: BaseSchema
Gömrükdə aparılmış əməliyyat
Fields:
-
operation_type(int | None) -
operation_type_description(str | None) -
operation_date(str | None)
integrify.ecustoms.schemas.response.AirwaybillOperationsSchema
pydantic-model
¶
Bases: BaseSchema
Aviaqaimə üzrə gömrük əməliyyatları
Fields:
-
status(int | None) -
operations(list[OperationSchema] | None)
integrify.ecustoms.schemas.response.DeclarationGoodsSchema
pydantic-model
¶
Bases: BaseSchema
Bəyannamədəki mal
Fields:
-
main_goods_group_unic_code(str | None) -
sub_goods_unic_code(str | None) -
goods_name(str | None) -
quantity_unit(str | None) -
quantity(float | None) -
quantity_full(str | None) -
currency_type(str | None) -
invoice_price(float | None) -
invoice_price_full(str | None) -
invoice_price_usd(str | None) -
invoice_price_usd_number(float | None) -
shipping_cost(float | None)
main_goods_group_unic_code = None
pydantic-field
¶
Malın aid olduğu əsas kateqoriya
sub_goods_unic_code = None
pydantic-field
¶
Malın aid olduğu alt kateqoriya
goods_name = None
pydantic-field
¶
Malın adı
quantity_unit = None
pydantic-field
¶
Ölçü vahidi
quantity = None
pydantic-field
¶
Malın miqdarı
quantity_full = None
pydantic-field
¶
Malın miqdarı (mətn formatında)
currency_type = None
pydantic-field
¶
Malın dəyərinin daxil edildiyi valyuta
invoice_price = None
pydantic-field
¶
Malın dəyəri
invoice_price_full = None
pydantic-field
¶
Malın dəyəri (mətn formatında)
invoice_price_usd = None
pydantic-field
¶
Malın dəyəri (USD). İlk malda daşınma xərci bu qiymətin üstünə əlavə edilir.
invoice_price_usd_number = None
pydantic-field
¶
Malın dəyəri (USD, rəqəm formatında)
shipping_cost = None
pydantic-field
¶
Bağlamanın daşınma xərci (USD)
model_config = ConfigDict(populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
integrify.ecustoms.schemas.response.DeclarationInfoSchema
pydantic-model
¶
Bases: BaseSchema
Vətəndaşın yazdığı bəyannamənin məlumatları
Fields:
-
id(str | None) -
reg_number(str | None) -
tracking_number(str | None) -
pay_status_id(str | None) -
pay_status(str | None) -
receive_status(str | None) -
approve_status(str | None) -
pin_number(str | None) -
import_name(str | None) -
phone(str | None) -
export_name(str | None) -
from_country(str | None) -
carrier_voen(str | None) -
insert_date(str | None) -
is_updated(bool | None) -
goods_list(list[DeclarationGoodsSchema] | None)
id = None
pydantic-field
¶
Bəyannamənin unikal ID kodu
reg_number = None
pydantic-field
¶
Bəyannamə nömrəsi
tracking_number = None
pydantic-field
¶
Bağlamanın Track ID-si
pay_status_id = None
pydantic-field
¶
Bəyannamənin limit statusu (kod) (bax: PayStatus)
pay_status = None
pydantic-field
¶
Bəyannamənin limit statusunun təsviri
receive_status = None
pydantic-field
¶
Bəyannamənin statusu (bax: DeclarationStatus)
approve_status = None
pydantic-field
¶
Bəyannamənin response listdən çıxarılma statusu (bax: ApproveStatus)
pin_number = None
pydantic-field
¶
Bağlama sahibinin FİN kodu
import_name = None
pydantic-field
¶
Bağlama sahibinin adı
phone = None
pydantic-field
¶
Bağlama sahibinin telefon nömrəsi
export_name = None
pydantic-field
¶
Malın alış ünvanı və ya göndərən
from_country = None
pydantic-field
¶
Bağlamanın çıxış ölkəsi
carrier_voen = None
pydantic-field
¶
Daşıyıcının VÖEN-i
insert_date = None
pydantic-field
¶
Bəyannamənin yazılma tarixi
is_updated = None
pydantic-field
¶
Bəyannaməyə düzəliş edilibmi
goods_list = None
pydantic-field
¶
Bəyannamədəki mallar
model_config = ConfigDict(populate_by_name=True, from_attributes=True)
class-attribute
instance-attribute
¶
integrify.ecustoms.schemas.response.DeletedDeclarationSchema
pydantic-model
¶
integrify.ecustoms.schemas.response.GoodsGroupSchema
pydantic-model
¶
Bases: BaseSchema
Sistemdə istifadə olunan mal qrupu
Fields:
-
id(str | None) -
parent_id(str | None) -
goods_name_az(str | None) -
goods_name_en(str | None) -
goods_name_ru(str | None) -
is_deleted(bool | None)
id = None
pydantic-field
¶
Kateqoriyanın ID-si
parent_id = None
pydantic-field
¶
Üst kateqoriyanın ID-si
goods_name_az = None
pydantic-field
¶
Kateqoriyanın Azərbaycan dilində adı
goods_name_en = None
pydantic-field
¶
Kateqoriyanın ingilis dilində adı
goods_name_ru = None
pydantic-field
¶
Kateqoriyanın rus dilində adı
is_deleted = None
pydantic-field
¶
True olarsa, yeni mallar üçün bu kateqoriya göstərilməməlidir