With the /OnDemandProducts endpoint user can manage OnDemandProducts from the database.
GET
/api/OnDemandProducts/List
Get a list of all OnDemandProducts
Request Example
/api/OnDemandProducts/List
RESPONSE EXAMPLE
[
{
"Id": "string",
"SKU": "string",
"Description": "string",
"ProductId": "string",
"ProductCode": "string",
"OrderType": "string",
"ColourId": "string",
"ColourName": "string",
"SizeId": "string",
"Locations": [
{
"Id": "string",
"LocationName": "string",
"TypeCode": "string"
}
]
},
{...}
]
GET
/api/OnDemandProducts/Get
Get a OnDemandProduct
Request Example
/api/OnDemandProducts/Get?id=OnDemandProductId?sku=sku
Use id parameter to get OnDemandProduct by id or
Use sku parameter to get OnDemandProduct by sku
RESPONSE EXAMPLE
If found, a OnDemandProduct is returned with status code 200. Otherwise an error with code and message is returned with status code 404
{
"Id": "string",
"SKU": "string",
"Description": "string",
"ProductId": "string",
"ProductCode": "string",
"OrderType": "string",
"ColourId": "string",
"ColourName": "string",
"SizeId": "string",
"Locations": [
{
"Id": "string",
"LocationName": "string",
"TypeCode": "string"
}
]
}
POST
/api/OnDemandProducts/Create
Create a OnDemandProduct
Model Request Example
{
"SKU": "string",
"Description": "string",
"ProductId": "string",
"OrderType" : "string",
"ColourId": "string",
"ColourName" : "",
"Locations" : [
{
"Id" : "string",
"LocationName" : "string",
"TypeCode" : "string"
},
{...}
]
}
Response Example
If the operation is successful a OnDemandProduct will be returned with status code 201
Otherwise an error with code and message will be returned with status code 409
PUT
/api/OnDemandProducts/Update
Update a OnDemandProduct
Request Example
/api/OnDemandProducts/Update?id=OnDemandProductId&sky=sku
Use id parameter to identify the OnDemandProduct to update by id or
Use sku parameter to identify the OnDemandProduct to update by sku
Model Request Example
All fields are updated
{
"SKU": "string",
"Description": "string",
"ProductId": "string",
"OrderType" : "string",
"ColourId": "string",
"ColourName" : "",
"Locations" : [
{
"Id" : "string",
"LocationName" : "string",
"TypeCode" : "string"
},
{...}
]
}
Response Example
If the operation is successful an empty response will be returned with status code 200
Otherwise an error with code and message will be returned with status code 409
DELETE
/api/OnDemandProducts/Delete
Delete a OnDemandProduct
Request Example
/api/OnDemandProducts/Delete?id=OnDemandProductId&sku=sku
Use id parameter to identify the OnDemandProduct to update by id or
Use sku parameter to identify the OnDemandProduct to delete by sku
Response Example
If the operation is successful an empty response will be returned with status code 200
Otherwise an error with code and message will be returned with status code 409