List and create order item transactions.
Lists transactions for an order item. The ID of the order item must be specified.
/rest/orders/items/{orderItemId}/transactions
| Field | Type | Description |
|---|---|---|
| orderItemId | Int |
The ID of the order item |
| columns | String[] |
The properties to be loaded |
| with | String[] |
Load additional relations for a transaction. Currently possible are 'orderItem' and 'warehouseLocation'. |
| Code | Exception | Description |
|---|---|---|
| 401 | League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 | League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Searches transactions by filter parameters.
/rest/orders/items/transactions
| Field | Type | Description |
|---|---|---|
| page | Int |
The page to get. The default page that will be returned is page 1. |
| itemsPerPage | Int |
The number of orders to be displayed per page. The default number of orders per page is 50. |
| columns | String[] |
The properties to be loaded |
| with | String[] |
Load additional relations for a transaction. Currently possible are 'orderItem' and 'warehouseLocation'. |
| orderItemId | Int |
The ID of the order item |
| orderId | Int |
The ID of the order |
| direction | String |
The direction of the transaction |
| status | String |
The status of the transaction |
| isBooked | Bool |
Returns all booked transactions |
| Field | Type | Description |
|---|---|---|
| page | Int |
Current page of the response |
| totalsCount | Int |
The total number of entries in the response |
| isLastPage | Bool |
Flag that indicates if the page shown is the last page of the response |
| lastPageNumber | Int |
The last page number |
| firstOnPage | Int |
The index of the first item of the current page result |
| lastOnPage | Int |
The index of the last item of the current page result |
| itemsPerPage | Int |
The requested amount of items per result page |
| entries | OrderItemTransaction[] |
List of OrderItemTransaction |
| id | Int |
The ID of the transaction |
| orderItemId | Int |
The ID of the order item |
| quantity | Float |
The quantity |
| userId | Int |
The ID of the user |
| identification | String |
External identification. Can be an arbitrary string. |
| direction | String |
The direction. Possible values are 'in' and 'out'. |
| status | String |
The status. Possible values are 'regular' and 'cancelled'. |
| receiptId | Int |
The receipt ID |
| warehouseLocationId | Int |
The ID of the warehouse location |
| batch | String |
The batch |
| bestBeforeDate | String |
The best before date |
| batchBestBeforeDateId | Int |
Deprecated. Replaced by $batch and $bestBeforeDate. |
| createdAt | String|\Carbon |
The date the transaction was created |
| updatedAt | String|\Carbon |
The date the transaction was last updated |
| Code | Exception | Description |
|---|---|---|
| 401 | League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 | League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
/rest/orders/items/{orderItemId}/transactions
| Field | Type | Description |
|---|---|---|
| id | Int |
The ID of the transaction |
| orderItemId | Int |
The ID of the order item |
| quantity | Float |
The quantity |
| userId | Int |
The ID of the user |
| identification | String |
External identification. Can be an arbitrary string. |
| direction | String |
The direction. Possible values are 'in' and 'out'. |
| status | String |
The status. Possible values are 'regular' and 'cancelled'. |
| receiptId | Int |
The receipt ID |
| warehouseLocationId | Int |
The ID of the warehouse location |
| batch | String |
The batch |
| bestBeforeDate | String |
The best before date |
| batchBestBeforeDateId | Int |
Deprecated. Replaced by $batch and $bestBeforeDate. |
| createdAt | String|\Carbon |
The date the transaction was created |
| updatedAt | String|\Carbon |
The date the transaction was last updated |
| Code | Exception | Description |
|---|---|---|
| 401 | League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 | League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
/rest/orders/items/transactions/{transactionId}
| Field | Type | Description |
|---|---|---|
| id | Int |
The ID of the transaction |
| orderItemId | Int |
The ID of the order item |
| quantity | Float |
The quantity |
| userId | Int |
The ID of the user |
| identification | String |
External identification. Can be an arbitrary string. |
| direction | String |
The direction. Possible values are 'in' and 'out'. |
| status | String |
The status. Possible values are 'regular' and 'cancelled'. |
| receiptId | Int |
The receipt ID |
| warehouseLocationId | Int |
The ID of the warehouse location |
| batch | String |
The batch |
| bestBeforeDate | String |
The best before date |
| batchBestBeforeDateId | Int |
Deprecated. Replaced by $batch and $bestBeforeDate. |
| createdAt | String|\Carbon |
The date the transaction was created |
| updatedAt | String|\Carbon |
The date the transaction was last updated |
| Code | Exception | Description |
|---|---|---|
| 401 | League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 | League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
/rest/orders/items/transactions/{transactionId}
| Code | Exception | Description |
|---|---|---|
| 401 | League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 | League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |