@sales-planner/shared 0.13.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -83,9 +83,10 @@ import type {
|
|
|
83
83
|
ImportSupplierItem, ImportSalesHistoryItem, ImportMarketplaceItem,
|
|
84
84
|
|
|
85
85
|
// Query types
|
|
86
|
-
ShopContextParams, PeriodQuery,
|
|
86
|
+
ShopContextParams, PaginationQuery, PeriodQuery, SalesHistoryQuery,
|
|
87
87
|
|
|
88
88
|
// Response types
|
|
89
|
+
PaginatedResponse,
|
|
89
90
|
UserWithRolesAndTenants, TenantWithShopAndApiKey,
|
|
90
91
|
ImportResult, DeleteDataResult,
|
|
91
92
|
SkuExportItem, BrandExportItem, CategoryExportItem, GroupExportItem, StatusExportItem,
|
|
@@ -126,13 +127,14 @@ The API uses **numeric IDs** internally for referential integrity:
|
|
|
126
127
|
| Type | Description |
|
|
127
128
|
|------|-------------|
|
|
128
129
|
| `ShopContextParams` | `{ shop_id: number; tenant_id: number }` |
|
|
130
|
+
| `PaginationQuery` | `{ limit?: number; offset?: number }` |
|
|
129
131
|
| `PeriodQuery` | `{ period_from?: string; period_to?: string }` |
|
|
132
|
+
| `SalesHistoryQuery` | `PaginationQuery & PeriodQuery` |
|
|
130
133
|
|
|
131
134
|
### Response Types
|
|
132
135
|
|
|
133
136
|
| Type | Description |
|
|
134
|
-
|
|
135
|
-
| `UserWithRolesAndTenants` | User with their roles and tenants |
|
|
137
|
+
|------|-------------|| `PaginatedResponse<T>` | `{ items: T[]; total: number; limit: number; offset: number }` || `UserWithRolesAndTenants` | User with their roles and tenants |
|
|
136
138
|
| `TenantWithShopAndApiKey` | Created tenant with shop and API key |
|
|
137
139
|
| `ImportResult` | `{ created: number; updated: number; errors: string[] }` |
|
|
138
140
|
| `DeleteDataResult` | `{ skusDeleted: number; salesHistoryDeleted: number; marketplacesDeleted: number }` |
|