u
This commit is contained in:
10
API.order.md
10
API.order.md
@@ -104,17 +104,23 @@ Lists the orders of the user's selected company.
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `googleAuthId` | `number` | The id of the Google auth user. |
|
||||
| `[opts]` | `object` | Optional pagination options. |
|
||||
| `[opts.offset=0]` | `number` | Number of orders to skip. |
|
||||
| `[opts.limit=20]` | `number` | Number of orders to return. |
|
||||
| `[tx]` | `object` | Optional transaction. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<Array<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string}>>` — The orders.
|
||||
`Promise<{orders: Array<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, createdAt: string|null, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string|null}>}>, total: number, offset: number, limit: number}|Array<object>>` — The orders.
|
||||
|
||||
**Example**
|
||||
|
||||
```js
|
||||
const result = await store.order.list(42, { offset: 0, limit: 20 });
|
||||
// => { orders: [...], total: 100, offset: 0, limit: 20 }
|
||||
|
||||
const orders = await store.order.list(42);
|
||||
// => [{ id, number, type, entityId, externalNumber, date }]
|
||||
// => [{ id, number, type, entityId, externalNumber, date, createdAt, lines: [...] }]
|
||||
```
|
||||
|
||||
## `order.update`
|
||||
|
||||
Reference in New Issue
Block a user