Các mô hình được liệt kê một lần ở đây và cũng có thể được mở rộng trực tiếp từ các điểm cuối sử dụng chúng.
Receipt14 trường
idinteger · int64
Id.
read-only
clientIdinteger · int64
- Đồ nhận khách hàng.
read-only
orderIdinteger · int64
Đơn vị nhận dạng.
read-only
organizationIdinteger · int64
Đơn vị tổ chức.
read-only
externalReceiptIdstring
Đơn nhận bên ngoài
fiscalNumberstring
Số tài chính.
cashRegisterServicestring
Dịch vụ ghi tiền mặt.
fnsUrlstring
Fns Url.
statusstring
Status.
receiptTypestring
Tiểu biên nhận.
totalAmountnumber · double
Tổng số tiền.
createdDatestring · date-time
Ngày được tạo ra.
read-only
completedDatestring · date-time
Ngày hoàn thành.
errorMessagestring
Thông báo lỗi.
Hợp đồng lỗi
Cách trả lại lỗi ứng dụng
Mã error giống nhau ở mọi địa điểm, trong khi thông điệp đối diện người dùng được dịch bởi máy chủ. Xây dựng logic ứng dụng xung quanh error và sử dụng localMessage chỉ cho hiển thị.
error
Mã máy tính có thể đọc ổn định cho logic tích hợp.
localMessage
Thông điệp sẵn sàng hiển thị trong ngôn ngữ của người dùng mã thông báo API.
params
Các giá trị được máy chủ liên kết vào mẫu tin nhắn địa phương.
文
localMessage sử dụng trường lang của người dùng sở hữu mã thông báo API. Ngôn ngữ tài liệu và tiêu đề Accept-Language không thay đổi nó; tiếng Nga được sử dụng khi người dùng không có ngôn ngữ được cấu hình.
RUUser locale là ru
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}
VNTiếng Việt (vn)
{
"error": "error_brand_already_exists",
"localMessage": "Thương hiệu Base đã tồn tại",
"params": {
"name": "Base"
}
}
Điểm cuối
Điểm cuối
GET
Nhận biên lai theo đơn đặt hàng
/api/receipt/order/{orderId}
Tấm mã với truy cập đọc
Nhận biên lai theo đơn đặt hàng bằng cách sử dụng GET /api/receipt/order/{orderId}.
Các tham số đường
Trường
Loại
Bắt buộc
Mô tả
orderId
integer · int64
Có
Đơn vị nhận dạng.
curl --request GET 'https://api.selsup.ru/api/receipt/order/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
POST
Tạo biên bản để đặt hàng
/api/receipt/order/{orderId}
Tấm mã với quyền truy cập viết
Tạo biên bản để đặt hàng bằng cách sử dụng POST /api/receipt/order/{orderId}.
Các tham số đường
Trường
Loại
Bắt buộc
Mô tả
orderId
integer · int64
Có
Đơn vị nhận dạng.
Các tham số truy vấn
Trường
Loại
Bắt buộc
Mô tả
typeGiá trị mặc định: INCOME
stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND
Không
Type.
curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
GET
Nhận biên bản
/api/receipt/{receiptId}
Tấm mã với truy cập đọc
Nhận Quí đơn bằng cách sử dụng GET /api/receipt/{receiptId}.
Các tham số đường
Trường
Loại
Bắt buộc
Mô tả
receiptId
integer · int64
Có
Đồ nhận.
curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
GET
Cập nhật trạng thái nhận
/api/receipt/{receiptId}/update
Tấm mã với truy cập đọc
Cập nhật trạng thái nhận bằng GET /api/receipt/{receiptId}/update.
Các tham số đường
Trường
Loại
Bắt buộc
Mô tả
receiptId
integer · int64
Có
Đồ nhận.
curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
--header 'Authorization: YOUR_API_TOKEN'
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.