Giao diện
API · profile
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 · 3 mutation.
Query
addressProvinces
Requires profile.manage. The Province / City catalogue (34 units) for the U-12 address form, by name. Same entries as the staff-only provinces.
query · quyền: profile.manage
Không có tham số.
Trả về [Province!]!
| Field | Kiểu | Mô tả |
|---|---|---|
code | String! | |
name | String! |
myAddresses
Requires profile.manage. The caller's live addresses, default first.
query · quyền: profile.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
page | Int | 1 | |
pageSize | Int | 20 |
Trả về AddressPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [Address!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! |
Mutation
deleteAddress
Requires profile.manage. Soft-deletes one non-default address.
mutation · quyền: profile.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | DeleteAddressInput! |
Trả về DeleteAddressResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction |
saveAddress
Requires profile.manage. Adds or replaces one of the caller's addresses. PAF: at most 10 addresses; a new 11th is refused with extensions.reason address_book_full (editing an existing one still works).
mutation · quyền: profile.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | SaveAddressInput! |
Trả về SaveAddressResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
address | Address! |
updateMe
Requires profile.manage. Saves the caller's own profile. A Sale (or any account holding an APP_SALE membership) gets policy_undecided: SPEC-06 has not classified Sale profile fields yet.
mutation · quyền: profile.manage
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | UpdateMeInput! |
Trả về UpdateMeResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | The caller's account id. |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
profile | Profile! |