Skip to content

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ểuMặc địnhMô tả
orderIdID!

Trả về OrderReturnCase

FieldKiểuMô tả
idID!
orderIdID!
shipmentIdID!
codCollectionIdID!
buyerIdID!
campaignIdID!
caseTypeString!RETURN.
causeString!COD_REFUSAL.
reasonString!Internal note; never shown to the buyer.
evidenceMediaIds[ID!]!
refusalSourceString!Where the refusal was read from: EVENT (a shipment fact) or EXCEPTION (an incident).
returnedAtDateTime!When the shipment came back (RETURNED).
codStatusString!The COD row when recorded: DUE or ASSIGNED, never collected.
codAmountDueVndVndAmount!
depositVndVndAmount!
pointsUsedPointAmount!
pointsValueVndVndAmount!
fromVersionInt!
toVersionInt!
policyRefString!DEC-COD-REFUSAL-REFUND@2026-10-06 (OI-FF-01@2026-10-05 for a case recorded before it).
depositDispositionString!REFUND_ALL_CAPTURES (DEC-COD-REFUSAL-REFUND); UNDECIDED for a case recorded before the decision (GAP-1321).
pointsDispositionString!REVERSE_ALL_ORIGINAL_REDEEM (DEC-COD-REFUSAL-REFUND); UNDECIDED for a case recorded before the decision (GAP-1321).
rewardDispositionString!CANCEL_ISSUE_PENDING_ONLY: the Pending reward is cancelled, an Available one is preserved.
undecidedRefStringThe open question behind UNDECIDED dispositions; null under DEC-COD-REFUSAL-REFUND.
recordedByID!
recordedAtDateTime!
refundCaseIdIDThe 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ểuMặc địnhMô tả
shipmentIdID
pageInt
pageSizeInt

Trả về OrderReturnCasePage!

FieldKiểuMô tả
items[OrderReturnCase!]!
totalInt!
pageInt!
pageSizeInt!

Sinh từ ad83b0aea · 820 migration · PostgreSQL 17