Delete an order item.
Deletes an order item. The ID of the order and the ID of the order item must be specified.
/rest/orders/{orderId}/items/{orderItemId}
Field | Type | Description |
---|---|---|
orderId | Int |
The ID of the order that the item belongs to. |
orderItemId | Int |
The ID of the order item to be deleted. |
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 order items. The ID of the order must be specified.
/rest/orders/{orderId}/items
Field | Type | Description |
---|---|---|
page | Int |
The page to get. The default page that will be returned is page 1. |
itemsPerPage | Int |
The number of order items to be displayed per page. The default number of order items per page is 50. The maximum number is 250. |
with | String[] |
Load additional relations for an order item. Currently possible are:
|
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 | OrderItem[] |
List of OrderItem |
id | Int |
The ID of the order item |
orderId | Int |
The ID of the order that the order item belongs to |
typeId | Int |
The ID of the order item type
|
referrerId | Float |
The ID of order item referrer |
itemVariationId | Int |
The ID of the item variation |
quantity | Float |
The quantity. |
orderItemName | String |
The name of the order item |
attributeValues | String |
The attribute value names |
shippingProfileId | Int |
The ID of the order item's shipping profile |
countryVatId | Int |
The ID of the country vat |
vatField | Int |
The vat id (0-3). |
vatRate | Float |
The vat amount, e.g. 19.0 for 19% VAT. |
position | Int |
The order items position in the order. |
warehouseId | Int |
The ID of the warehouse. |
createdAt | String|\Carbon |
The date at which the order item was created. |
updatedAt | String|\Carbon |
The date that the order item 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. |