Order return
journal
Журнал возвратов по департаменту и диапазону даты .request
GET /api/v2/order-returns?returnOnFrom=2020-01-01&returnOnTo=2020-12-01&departmentIds=1000000003,1000000003 HTTP/1.1
Unresolved directive in index.adoc - include::/builds/itigris/optima-core/optima/optima-2-backend/target/generated-snippets/order-return-journal-filter/request-fields.adoc[] .response
HTTP/1.1 200 OK
{
"content" : [ {
"date" : "26-05-2020",
"num" : 19,
"orderId" : 1000000120,
"departmentName" : "Первый магазин",
"user" : {
"id" : 1000000022,
"firstName" : "Тимофей",
"familyName" : "Кадын",
"patronymicName" : "Юрьевич",
"fullName" : "Кадын Тимофей Юрьевич",
"shortName" : "Кадын Т. Ю."
},
"comment" : "тест",
"count" : 1,
"sum" : 1190.0
}, {
"date" : "09-05-2020",
"num" : 18,
"orderId" : 1000000112,
"departmentName" : "Первый магазин",
"user" : {
"id" : 1000000022,
"firstName" : "Тимофей",
"familyName" : "Кадын",
"patronymicName" : "Юрьевич",
"fullName" : "Кадын Тимофей Юрьевич",
"shortName" : "Кадын Т. Ю."
},
"comment" : "отказ",
"count" : 5,
"sum" : 5.0
}, {
"date" : "05-03-2020",
"num" : 17,
"orderId" : 1000000102,
"departmentName" : "Первый магазин",
"user" : {
"id" : 1000000004,
"firstName" : "Иван",
"familyName" : "Иванов",
"patronymicName" : null,
"fullName" : "Иванов Иван",
"shortName" : "Иванов И."
},
"comment" : "dg",
"count" : 7,
"sum" : 7.0
} ],
"pageable" : {
"pageNumber" : 0,
"pageSize" : 10,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"offset" : 0,
"paged" : true,
"unpaged" : false
},
"last" : true,
"totalElements" : 3,
"totalPages" : 1,
"first" : true,
"size" : 10,
"number" : 0,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"numberOfElements" : 3,
"empty" : false
}
| Path | Type | Description |
|---|---|---|
|
|
Array of filtered order returns |
|
|
order return creation date in format dd-MM-yyyy |
|
|
order return id |
|
|
order id |
|
|
name of department where order was returned |
|
|
|
|
|
user’s first name |
|
|
user’s second name |
|
|
user’s patronymic name |
|
|
reason of order return |
|
|
count of serves and goods in order return |
|
|
return cost |
get
Просмотр возврата по его номеру .request
GET /api/v2/order-returns/18 HTTP/1.1
| Parameter | Description |
|---|---|
|
id(num) of order return |
HTTP/1.1 200 OK
{
"returnId" : 18,
"orderId" : 1000000112,
"user" : {
"id" : 1000000022,
"firstName" : "Тимофей",
"familyName" : "Кадын",
"patronymicName" : "Юрьевич",
"fullName" : "Кадын Тимофей Юрьевич",
"shortName" : "Кадын Т. Ю."
},
"returnedOn" : "09.05.2020",
"departmentId" : 1000000003,
"departmentName" : "Первый магазин",
"departmentPhone" : "+7(812) 425-64-22",
"sum" : 5.0,
"returnableResponses" : [ {
"returnPrice" : 1.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "AccessoryResponse",
"id" : 1000012191,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "ACCESSORY",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"accessoryCategory" : "Не маркируемые товары",
"model" : "Винты-болты",
"orderId" : null
}
}, {
"returnPrice" : 1.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "AccessoryResponse",
"id" : 1000012193,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "ACCESSORY",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"accessoryCategory" : "Не маркируемые товары",
"model" : "Винты-болты",
"orderId" : null
}
}, {
"returnPrice" : 1.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "AccessoryResponse",
"id" : 1000012195,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "ACCESSORY",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"accessoryCategory" : "Не маркируемые товары",
"model" : "Винты-болты",
"orderId" : null
}
}, {
"returnPrice" : 1.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "AccessoryResponse",
"id" : 1000012192,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "ACCESSORY",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"accessoryCategory" : "Не маркируемые товары",
"model" : "Винты-болты",
"orderId" : null
}
}, {
"returnPrice" : 1.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "AccessoryResponse",
"id" : 1000012194,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "ACCESSORY",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"accessoryCategory" : "Не маркируемые товары",
"model" : "Винты-болты",
"orderId" : null
}
} ],
"comment" : "отказ",
"cash" : 0.0,
"card" : 5.0,
"canPrintReturnCheck" : true,
"hasElectronicReceipts" : false,
"hasBarcodeSettingsModes" : false,
"canChangePaymentType" : false
}
| Path | Type | Description |
|---|---|---|
|
|
order return creation date in format dd-MM-yyyy |
|
|
order return id |
|
|
order id |
|
|
name of department where order was returned |
|
|
|
|
|
user’s first name |
|
|
user’s second name |
|
|
user’s patronymic name |
|
|
reason of order return |
|
|
count of serves and goods in order return |
|
|
return cost |
get by order
Просмотр возврата по номеру его заказа .request
GET /api/v2/order-returns/by-order/1000000022 HTTP/1.1
| Parameter | Description |
|---|---|
|
order id |
HTTP/1.1 200 OK
{
"content" : [ {
"date" : "12-02-2019",
"num" : 3,
"orderId" : 1000000022,
"departmentName" : "Первый магазин",
"user" : {
"id" : 1000000004,
"firstName" : "Иван",
"familyName" : "Иванов",
"patronymicName" : null,
"fullName" : "Иванов Иван",
"shortName" : "Иванов И."
},
"comment" : "возврат",
"count" : 1,
"sum" : 700.0
} ],
"pageable" : {
"pageNumber" : 0,
"pageSize" : 10,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"offset" : 0,
"paged" : true,
"unpaged" : false
},
"last" : true,
"totalElements" : 1,
"totalPages" : 1,
"first" : true,
"size" : 10,
"number" : 0,
"sort" : {
"empty" : false,
"sorted" : true,
"unsorted" : false
},
"numberOfElements" : 1,
"empty" : false
}
| Path | Type | Description |
|---|---|---|
|
|
Array of filtered order returns |
|
|
order return creation date in format dd-MM-yyyy |
|
|
order return id |
|
|
order id |
|
|
name of department where order was returned |
|
|
|
|
|
user’s first name |
|
|
user’s second name |
|
|
user’s patronymic name |
|
|
reason of order return |
|
|
count of serves and goods in order return |
|
|
return cost |
get by goods
Просмотр возврата по (новому) номеру товара, возвращённому в этом возврате .request
GET /api/v2/order-returns/by-goods/999999997 HTTP/1.1
| Parameter | Description |
|---|---|
|
Goods' ID |
HTTP/1.1 200 OK
{
"returnId" : 999999999,
"orderId" : 999999999,
"user" : {
"id" : 1000000014,
"firstName" : "Тимофей",
"familyName" : "Кадын",
"patronymicName" : "Юрьевич",
"fullName" : "Кадын Тимофей Юрьевич",
"shortName" : "Кадын Т. Ю."
},
"returnedOn" : "16.11.2025",
"departmentId" : 1000000006,
"departmentName" : "Четвертый магазин",
"departmentPhone" : "+7(812) 425-64-22",
"sum" : 9100.0,
"returnableResponses" : [ {
"returnPrice" : 2000.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "CartServeResponse",
"id" : 999999999,
"retailPrice" : 2000.0,
"purchasingPrice" : null,
"soldPrice" : 2000.0,
"baseSalePrice" : null,
"sellableCategory" : "SERVE",
"expected" : false,
"serveType" : {
"id" : 999999998,
"name" : "Test"
},
"comment" : null,
"employee" : null,
"serveTypeIds" : null,
"orderId" : null
}
}, {
"returnPrice" : 5000.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "GiftCertificateResponse",
"id" : 999999999,
"retailPrice" : 5000.0,
"purchasingPrice" : null,
"soldPrice" : 5000.0,
"baseSalePrice" : null,
"sellableCategory" : "GIFT_CERTIFICATE",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"certificateNumber" : null,
"active" : true,
"orderId" : null
}
}, {
"returnPrice" : 100.0,
"printBarcode" : true,
"sellableParams" : {
"className" : "AccessoryResponse",
"id" : 999999997,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "ACCESSORY",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"accessoryCategory" : "Подарок",
"model" : "магнит 892-Е20",
"orderId" : null
}
}, {
"returnPrice" : 2000.0,
"printBarcode" : true,
"sellableParams" : {
"className" : "ContactLensResponse",
"id" : 999999996,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "CONTACT_LENS",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"manufacturer" : "Interojo",
"name" : "1-Day Acuvue Oasys",
"color" : null,
"curvatureRadius" : 7.8,
"diameter" : 14.3,
"wearingPeriod" : "2 недели",
"dioptre" : -6.5,
"cylinder" : null,
"axis" : null,
"add" : null,
"packageQuantity" : 4,
"currentQuantity" : 4,
"restQuantity" : 4,
"onlyFullPackages" : null,
"dioptresFrom" : null,
"dioptresTo" : null,
"cylinderFrom" : null,
"cylinderTo" : null,
"expireOnFrom" : null,
"expireOnTo" : null,
"matchPrescription" : null,
"manufacturerName" : "Interojo",
"brandName" : "1-Day Acuvue Oasys",
"orderId" : null,
"expireAt" : null
}
} ],
"comment" : null,
"cash" : 9100.0,
"card" : 0.0,
"canPrintReturnCheck" : true,
"hasElectronicReceipts" : false,
"hasBarcodeSettingsModes" : false,
"canChangePaymentType" : false
}
| Path | Type | Description |
|---|---|---|
|
|
Returned order’s ID |
|
|
The return’s date in format dd.MM.yyyy |
|
|
The return’s sum |
|
|
The return’s comment |
|
|
The return’s card sum |
|
|
The return’s cash sum |
|
|
User that created the return |
|
|
The user’s ID |
|
|
The user’s first name |
|
|
The user’s last name |
|
|
The user’s patronymic name |
|
|
The name of the Department that received the return |
|
|
The department’s phone number |
|
|
availableCash |
|
|
canPrintReturnCheck |
|
|
hasElectronicReceipts |
|
|
hasBarcodeSettingsModes |
get by service
Просмотр возврата по номеру услуги, возвращённой в этом возврате .request
GET /api/v2/order-returns/by-serve/999999999 HTTP/1.1
| Parameter | Description |
|---|---|
|
Service’s ID |
HTTP/1.1 200 OK
{
"returnId" : 999999999,
"orderId" : 999999999,
"user" : {
"id" : 1000000014,
"firstName" : "Тимофей",
"familyName" : "Кадын",
"patronymicName" : "Юрьевич",
"fullName" : "Кадын Тимофей Юрьевич",
"shortName" : "Кадын Т. Ю."
},
"returnedOn" : "16.11.2025",
"departmentId" : 1000000006,
"departmentName" : "Четвертый магазин",
"departmentPhone" : "+7(812) 425-64-22",
"sum" : 9100.0,
"returnableResponses" : [ {
"returnPrice" : 2000.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "CartServeResponse",
"id" : 999999999,
"retailPrice" : 2000.0,
"purchasingPrice" : null,
"soldPrice" : 2000.0,
"baseSalePrice" : null,
"sellableCategory" : "SERVE",
"expected" : false,
"serveType" : {
"id" : 999999998,
"name" : "Test"
},
"comment" : null,
"employee" : null,
"serveTypeIds" : null,
"orderId" : null
}
}, {
"returnPrice" : 5000.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "GiftCertificateResponse",
"id" : 999999999,
"retailPrice" : 5000.0,
"purchasingPrice" : null,
"soldPrice" : 5000.0,
"baseSalePrice" : null,
"sellableCategory" : "GIFT_CERTIFICATE",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"certificateNumber" : null,
"active" : true,
"orderId" : null
}
}, {
"returnPrice" : 100.0,
"printBarcode" : true,
"sellableParams" : {
"className" : "AccessoryResponse",
"id" : 999999997,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "ACCESSORY",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"accessoryCategory" : "Подарок",
"model" : "магнит 892-Е20",
"orderId" : null
}
}, {
"returnPrice" : 2000.0,
"printBarcode" : true,
"sellableParams" : {
"className" : "ContactLensResponse",
"id" : 999999996,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "CONTACT_LENS",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"manufacturer" : "Interojo",
"name" : "1-Day Acuvue Oasys",
"color" : null,
"curvatureRadius" : 7.8,
"diameter" : 14.3,
"wearingPeriod" : "2 недели",
"dioptre" : -6.5,
"cylinder" : null,
"axis" : null,
"add" : null,
"packageQuantity" : 4,
"currentQuantity" : 4,
"restQuantity" : 4,
"onlyFullPackages" : null,
"dioptresFrom" : null,
"dioptresTo" : null,
"cylinderFrom" : null,
"cylinderTo" : null,
"expireOnFrom" : null,
"expireOnTo" : null,
"matchPrescription" : null,
"manufacturerName" : "Interojo",
"brandName" : "1-Day Acuvue Oasys",
"orderId" : null,
"expireAt" : null
}
} ],
"comment" : null,
"cash" : 9100.0,
"card" : 0.0,
"canPrintReturnCheck" : true,
"hasElectronicReceipts" : false,
"hasBarcodeSettingsModes" : false,
"canChangePaymentType" : false
}
| Path | Type | Description |
|---|---|---|
|
|
Returned order’s ID |
|
|
The return’s date in format dd.MM.yyyy |
|
|
The return’s sum |
|
|
The return’s comment |
|
|
The return’s card sum |
|
|
The return’s cash sum |
|
|
User that created the return |
|
|
The user’s ID |
|
|
The user’s first name |
|
|
The user’s last name |
|
|
The user’s patronymic name |
|
|
The name of the Department that received the return |
|
|
The department’s phone number |
|
|
availableCash |
|
|
canPrintReturnCheck |
|
|
hasElectronicReceipts |
|
|
hasBarcodeSettingsModes |
get by gift certificate
Просмотр возврата по номеру подарочного сертификата, возвращённому в этом возврате .request
GET /api/v2/order-returns/by-gift-certificate/999999999 HTTP/1.1
| Parameter | Description |
|---|---|
|
Gift certificate’s ID |
HTTP/1.1 200 OK
{
"returnId" : 999999999,
"orderId" : 999999999,
"user" : {
"id" : 1000000014,
"firstName" : "Тимофей",
"familyName" : "Кадын",
"patronymicName" : "Юрьевич",
"fullName" : "Кадын Тимофей Юрьевич",
"shortName" : "Кадын Т. Ю."
},
"returnedOn" : "16.11.2025",
"departmentId" : 1000000006,
"departmentName" : "Четвертый магазин",
"departmentPhone" : "+7(812) 425-64-22",
"sum" : 9100.0,
"returnableResponses" : [ {
"returnPrice" : 2000.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "CartServeResponse",
"id" : 999999999,
"retailPrice" : 2000.0,
"purchasingPrice" : null,
"soldPrice" : 2000.0,
"baseSalePrice" : null,
"sellableCategory" : "SERVE",
"expected" : false,
"serveType" : {
"id" : 999999998,
"name" : "Test"
},
"comment" : null,
"employee" : null,
"serveTypeIds" : null,
"orderId" : null
}
}, {
"returnPrice" : 5000.0,
"printBarcode" : false,
"sellableParams" : {
"className" : "GiftCertificateResponse",
"id" : 999999999,
"retailPrice" : 5000.0,
"purchasingPrice" : null,
"soldPrice" : 5000.0,
"baseSalePrice" : null,
"sellableCategory" : "GIFT_CERTIFICATE",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"certificateNumber" : null,
"active" : true,
"orderId" : null
}
}, {
"returnPrice" : 100.0,
"printBarcode" : true,
"sellableParams" : {
"className" : "AccessoryResponse",
"id" : 999999997,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "ACCESSORY",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"accessoryCategory" : "Подарок",
"model" : "магнит 892-Е20",
"orderId" : null
}
}, {
"returnPrice" : 2000.0,
"printBarcode" : true,
"sellableParams" : {
"className" : "ContactLensResponse",
"id" : 999999996,
"retailPrice" : null,
"purchasingPrice" : null,
"soldPrice" : null,
"baseSalePrice" : null,
"sellableCategory" : "CONTACT_LENS",
"expected" : false,
"basePrice" : null,
"barcode" : null,
"factory" : false,
"departmentName" : null,
"goodsStatus" : null,
"manufacturer" : "Interojo",
"name" : "1-Day Acuvue Oasys",
"color" : null,
"curvatureRadius" : 7.8,
"diameter" : 14.3,
"wearingPeriod" : "2 недели",
"dioptre" : -6.5,
"cylinder" : null,
"axis" : null,
"add" : null,
"packageQuantity" : 4,
"currentQuantity" : 4,
"restQuantity" : 4,
"onlyFullPackages" : null,
"dioptresFrom" : null,
"dioptresTo" : null,
"cylinderFrom" : null,
"cylinderTo" : null,
"expireOnFrom" : null,
"expireOnTo" : null,
"matchPrescription" : null,
"manufacturerName" : "Interojo",
"brandName" : "1-Day Acuvue Oasys",
"orderId" : null,
"expireAt" : null
}
} ],
"comment" : null,
"cash" : 9100.0,
"card" : 0.0,
"canPrintReturnCheck" : true,
"hasElectronicReceipts" : false,
"hasBarcodeSettingsModes" : false,
"canChangePaymentType" : false
}
| Path | Type | Description |
|---|---|---|
|
|
Returned order’s ID |
|
|
The return’s date in format dd.MM.yyyy |
|
|
The return’s sum |
|
|
The return’s comment |
|
|
The return’s card sum |
|
|
The return’s cash sum |
|
|
User that created the return |
|
|
The user’s ID |
|
|
The user’s first name |
|
|
The user’s last name |
|
|
The user’s patronymic name |
|
|
The name of the Department that received the return |
|
|
The department’s phone number |
|
|
availableCash |
|
|
canPrintReturnCheck |
|
|
hasElectronicReceipts |
|
|
hasBarcodeSettingsModes |
update payment type
Обновить распределение возвратного платежа по типам оплаты .request Unresolved directive in index.adoc - include::/builds/itigris/optima-core/optima/optima-2-backend/target/generated-snippets/order-return-update-payment-type/http-request.adoc[] .request description Unresolved directive in index.adoc - include::/builds/itigris/optima-core/optima/optima-2-backend/target/generated-snippets/order-return-update-payment-type/path-parameters.adoc[] Unresolved directive in index.adoc - include::/builds/itigris/optima-core/optima/optima-2-backend/target/generated-snippets/order-return-update-payment-type/response-fields.adoc[] .response Unresolved directive in index.adoc - include::/builds/itigris/optima-core/optima/optima-2-backend/target/generated-snippets/order-return-update-payment-type/http-response.adoc[]