Store returns
A customer return received and processed at a retail site.
- API name:
storereturns - Domain: Retail
- Modules: Sales analytics, Stores
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text | ||
| Return number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | Calendar date for this value. |
| Sale | storepossaleId | Reference | ||
| Register session | storecashregistersessionId | Reference | Yes | |
| Customer | customerId | Reference | ||
| User | userId | User | ||
| Reason | reason | Constant | Return reason from the sales returns catalog. | |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Data | data | Data | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Processed by | processedBy | User | ||
| Processed at | processedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Sale storepossaleId | POS sales | reference |
Register session storecashregistersessionId | Register sessions | reference |
Customer customerId | Customers | reference |
User userId | Users | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event storereturns.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new return. | App · API · MCP · CLI |
| Edit | update | Save changes to this return. | App · API · MCP · CLI |
| Process | process | Post this return. You cannot undo it. | App · API · MCP · CLI |
| Cancel | cancel | Cancel the processed return and reverse the refund, credit note and stock receipt. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this return. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this return again. | App · API · MCP · CLI |
| Archive | archive | Retire this return from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this return to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this return and the data that belongs with it. This cannot be undone. | App · API · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.