Giao diện
API · order-return
Trang sinh tự động
Parse từ schema.graphql (SDL backend export) bằng parser graphql. Mô tả và quyền lấy nguyên văn từ description trong SDL.
2 query · 0 mutation.
Query
orderReturnCase
The RETURN case of one Order, or null. Requires order.read (GAP-1320: no role yet).
query · quyền: order.read
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
orderId | ID! |
Trả về OrderReturnCase
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
orderId | ID! | |
shipmentId | ID! | |
codCollectionId | ID! | |
buyerId | ID! | |
campaignId | ID! | |
caseType | String! | RETURN. |
cause | String! | COD_REFUSAL. |
reason | String! | Internal note; never shown to the buyer. |
evidenceMediaIds | [ID!]! | |
refusalSource | String! | Where the refusal was read from: EVENT (a shipment fact) or EXCEPTION (an incident). |
returnedAt | DateTime! | When the shipment came back (RETURNED). |
codStatus | String! | The COD row when recorded: DUE or ASSIGNED, never collected. |
codAmountDueVnd | VndAmount! | |
depositVnd | VndAmount! | |
pointsUsed | PointAmount! | |
pointsValueVnd | VndAmount! | |
fromVersion | Int! | |
toVersion | Int! | |
policyRef | String! | DEC-COD-REFUSAL-REFUND@2026-10-06 (OI-FF-01@2026-10-05 for a case recorded before it). |
depositDisposition | String! | REFUND_ALL_CAPTURES (DEC-COD-REFUSAL-REFUND); UNDECIDED for a case recorded before the decision (GAP-1321). |
pointsDisposition | String! | REVERSE_ALL_ORIGINAL_REDEEM (DEC-COD-REFUSAL-REFUND); UNDECIDED for a case recorded before the decision (GAP-1321). |
rewardDisposition | String! | CANCEL_ISSUE_PENDING_ONLY: the Pending reward is cancelled, an Available one is preserved. |
undecidedRef | String | The open question behind UNDECIDED dispositions; null under DEC-COD-REFUSAL-REFUND. |
recordedBy | ID! | |
recordedAt | DateTime! | |
refundCaseId | ID | The manual refund case this return opened (Finance approves it); null when nothing was refundable or for a case recorded before DEC-COD-REFUSAL-REFUND. |
orderReturnCases
RETURN cases, newest first, optionally of one shipment. Requires order.read.
query · quyền: order.read
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
shipmentId | ID | ||
page | Int | ||
pageSize | Int |
Trả về OrderReturnCasePage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [OrderReturnCase!]! | |
total | Int! | |
page | Int! | |
pageSize | Int! |