دریافت لیست
متد | endpoint |
---|---|
Get | warehouses/ |
Response
"warehouses": [
{
"id": 1,
"accountingCode": "0001",
"title":"انبار اصلی",
"warehouseKeeper": "علی حسینی",
"phone": "0211111111",
"address": "کیلومتر 15 جاده مخصوص",
"active": true,
"BusinessId": 87,
"updatedAt": "2022-10-01 07:26:02",
"createdAt": "2022-10-01 07:26:02"
}
...
]
دریافت از طریق Id
متد | endpoint |
---|---|
Get | warehouses/{id} |
Request
عنوان پارامتر | نوع پارامتر | نوع داده | توضیحات |
---|---|---|---|
id | اجباری | Integer | Id انبار |
Response
{
"id": 1,
"accountingCode": "0001",
"title":"انبار اصلی",
"warehouseKeeper": "علی حسینی",
"phone": "0211111111",
"address": "کیلومتر 15 جاده مخصوص",
"active": true,
"BusinessId": 87,
"updatedAt": "2022-10-01 07:26:02",
"createdAt": "2022-10-01 07:26:02"
}
ذخیره
متد | endpoint |
---|---|
Post | warehouses/ |
Request
عنوان پارامتر | نوع پارامتر | نوع داده | توضیحات |
---|---|---|---|
accountingCode | اختیاری | String | کد شخص در صورتی که کد شخص را وارد نکنید، شخص جدید ذخیره می شود. در صورتی که کد وارد شود و موجود باشد، اطلاعات ویرایش می شود.در صورتی که کد وارد شود و موجود نباشد، شخص با آن کد ذخیره خواهد شد. کد باید به صورت رشته ای از اعداد شد |
nickName | اجباری | String | نام مستعار |
isLegal | اختیاری | String | |
firstName | اختیاری | String | نام |
lastName | اختیاری | String | نام خانوادگی |
active | اختیاری | Boolean | وضعیت فعال یا غیر فعال کاربر |
personType | اجباری | Enum(customer,personnel,seller,provider) | نوع شخص که فقط یکی از موارد (customer,personnel,seller,provider) می تواند باشد |
personTypeId | اختیاری | Integer | دسته بندی شخص |
financialCredit | اختیاری | Integer | اعتبار مالی |
tax | اختیاری | Integer | مالیات |
description | اختیاری | String | توضیحات |
country | اختیاری | String | کشور |
state | اختیاری | String | استان |
city | اختیاری | String | شهر |
postalCode | اختیاری | String | |
address | اختیاری | String | |
phone | اختیاری | String | |
mobile | اختیاری | String | |
اختیاری | String | ||
website | اختیاری | String | |
bankName | اختیاری | String | |
bankAccountNumber | اختیاری | String | |
bankCardNumber | اختیاری | String | |
bankShaba | اختیاری | String | |
jobPosition | اختیاری | String | |
salary | اختیاری | String | |
contractStart | اختیاری | String | |
contractEnd | اختیاری | String | |
contractDescription | اختیاری | String | |
commissionInput | اختیاری | String |
مثال
{
"main": {
"accountingCode": "010",
"nickName": "ذکتر پارسا",
"firstName": "محمود",
"lastName": "پارسا",
"title": "دکتر پارسا",
"company": null,
"description": "مشتری اینترنت پرسرعت",
"active": true,
"personType": "customer",
"personTypeId": 1
},
"others": [
{"financialCredit": "500000"},
{"economicCode": "12345"},
{"registerationNumber": "12345678"},
{"postalCode": "1234567890"},
{"country": "ایران"},
{"state": "تهران"},
{"city": "تهران"},
{"address": "تهران_میدان ولیعصر"},
{"phone": "02112345678"},
{"mobile": "09123456789"},
{"email": "personEmail@gmail.com"},
{"website": "person.web"},
{"bankName": "ملی"},
{"bankAccountNumber": "0012345678"},
{"bankCardNumber": "1234123412341234"},
{"bankShaba": "12341234123412341234"}
]
}
Response
"warehouse": {
"id": 1,
"accountingCode": "0001",
"title":"انبار اصلی",
"warehouseKeeper": "علی حسینی",
"phone": "0211111111",
"address": "کیلومتر 15 جاده مخصوص",
"active": true,
"BusinessId": 87,
"updatedAt": "2022-10-01 07:26:02",
"createdAt": "2022-10-01 07:26:02"
}
ویرایش
متد | endpoint |
---|---|
Put | warehouses/{id} |
Request
عنوان پارامتر | نوع پارامتر | نوع داده | توضیحات |
---|---|---|---|
id | اجباری | Integer | Id انبار |
Response
"warehouse": {
"id": 1,
"accountingCode": "0001",
"title":"انبار اصلی",
"warehouseKeeper": "علی حسینی",
"phone": "0211111111",
"address": "کیلومتر 15 جاده مخصوص",
"active": true,
"BusinessId": 87,
"updatedAt": "2022-10-01 07:26:02",
"createdAt": "2022-10-01 07:26:02"
}
حذف
متد | endpoint |
---|---|
Delete | warehouses/{id} |
Request
عنوان پارامتر | نوع پارامتر | نوع داده | توضیحات |
---|---|---|---|
id | اجباری | Integer | Id انبار |
Response
{
"message": "انبار انتخاب شده با موفقیت حذف شد"
}