GET PlaceOrder/OrderItemModel
This endpoint does nothing and exists solely for the Auto Generated Documentation as the OrderItem Type is now Complex
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
CreateApiOrderItemCommandName | Type | Description | Additional information |
---|---|---|---|
ProductID | integer |
None. |
|
ProductName | string |
The name of the product being ordered |
|
PriceId | integer |
The Tevalis Price ID that comes from the product catalogue. You can now optionally send the PLU for the PriceID instead, however this must be unique so that the PLU can match back to the Price |
|
PLU | string |
None. |
|
Quantity | integer |
Required |
|
TotalGross | decimal number |
Required Range: inclusive between 0 and 1.79769313486232E+308 |
|
VatName | string |
This field is no longer used |
|
APIOrderItemType | string |
None. |
|
VatRate | decimal number |
None. |
|
Discounts | Collection of CreateApiOrderItemDiscountCommand |
None. |
|
Options | Collection of CreateApiOrderItemOptionCommand |
None. |
|
ItemNotes | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "VatRate": 1.0, "Discounts": [ { "ReasonTypeId": 1, "Amount": 2.0 }, { "ReasonTypeId": 1, "Amount": 2.0 } ], "Options": [ { "Options": [], "OptionGroupID": 1, "OptionItemID": 2, "TotalGross": 3.0, "IsRemove": true }, { "Options": [], "OptionGroupID": 1, "OptionItemID": 2, "TotalGross": 3.0, "IsRemove": true } ], "ItemNotes": [ "sample string 1", "sample string 2" ], "ProductID": 1, "ProductName": "sample string 1", "PriceId": 2, "PLU": "sample string 3", "Quantity": 4, "TotalGross": 5.0, "VatName": "sample string 6", "APIOrderItemType": "sample string 7" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.