public
|
#
post( )
Api
{post} /orders/:id/items Create Order Item
Apidescription
Use this method to create a new order item to an existing order. The order item JSON format must be the
same with the "items" entries in the original order item.
Apierror
400-BadRequest The request body was empty.
(Error 5xx) 500-InternalError One of the given properties has an invalid value type.
Apierrorexample
Error-Response
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "Order item data were not provided."
}
Apiexample
{json} Request-Body
{
"model": "12345-s-black",
"name": "Ein Artikel",
"quantity": 1,
"price": 11,
"finalPrice": 11,
"tax": 19,
"isTaxAllowed": true,
"discount": 0,
"shippingTimeInformation": "",
"checkoutInformation": "Checkout information goes here ...",
"quantityUnitName": "Liter",
"attributes": [
{
"id": 1,
"name": "Farbe",
"value": "rot",
"price": 0,
"priceType": "+",
"optionId": 1,
"optionValueId": 1,
"combisId": null
}
],
"downloadInformation": {
"filename": "Dokument.pdf",
"maxDaysAllowed": 5,
"countAvailable": 14
},
"addonValues": {
"productId": "2",
"quantityUnitId": "1"
}
}
Apigroup
Orders
Apiname
CreateOrderItem
Apisuccess
(Success 201) Response-Body If successful, this method returns a complete Order Item resource in the
response body.
Apiversion
2.1.0
|
public
|
#
put( )
Api
{put} /orders/:id/items/:id Update Order Item
Apidescription
Use this method to update an existing order item. Use the same order item JSON format as in the POST method.
Apierror
400-BadRequest The request body is empty or the order item ID in the URI was not provided or is invalid.
404-NotFound The provided order item was not found in the given order.
Apierrorexample
Error-Response (Empty request body)
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "Order item data were not provided."
}
Error-Response (Missing or invalid ID)
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "Order item record ID was not provided or is invalid."
}
Error-Response (Not found in order)
HTTP/1.1 404 Not Found
{
"code": 404,
"status": "error",
"message": "The provided order item ID does not exist in the given order!"
}
Apigroup
Orders
Apiname
UpdateOrderItem
Apisuccess
Response-Body If successful, this method returns the updated Order Item resource in the response body.
Apiversion
2.1.0
|
public
|
#
delete( )
Api
{delete} /orders/:id/items/:id Delete Order Item
Apidescription
Use this method to remove an order item from an existing order.
Apierror
400-BadRequest The order item ID in the URI was not provided or is invalid.
404-NotFound The provided order item was not found in the given order.
Apierrorexample
Error-Response (Missing ID)
HTTP/1.1 400 Bad Request
{
"code": 400,
"status": "error",
"message": "Order item record ID was not provided in the resource URL."
}
Error-Response (Not found in order)
HTTP/1.1 404 Not Found
{
"code": 404,
"status": "error",
"message": "The provided order item ID does not exist in the given order!"
}
Apigroup
Orders
Apiname
DeleteOrderItem
Apisuccessexample
{json} Success-Response
{
"code": 200,
"status": "success",
"action" :"delete",
"resource": "OrderItem",
"orderId": 400883,
"orderItemId": 1
}
Apiversion
2.1.0
|