Update Order Types
post
/config/sim/v1/setup/updateordertypenames
Updates the Order Type. If Order Type is not found, it creates a new Order Type
Release | Description |
---|---|
23.5 | Starting from Simphony version 19.8, Update Order Types API will no longer add records. |
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
CUD Request Body
Root Schema : OrderTypeCUDRequestBody
Type:
object
Model for Order Type CUD Request
Show Source
-
dataExtensions:
array dataExtensions
An array of data extensions for the Order Types
-
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2
-
lineNum(required):
integer
Line number of the Order TypesExample:
1
-
name(required):
object name
Name
Nested Schema : dataExtensions
Type:
array
An array of data extensions for the Order Types
Show Source
Nested Schema : name
Type:
object
Name
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}
Nested Schema : OrderType_dataExtentions
Type:
Show Source
object
-
columnName:
string
Name of the extention fieldExample:
Extention Column 1
-
value:
string
Value of the extention fieldExample:
Value 1
Response
Supported Media Types
- application/json
200 Response
Order Type Name Updated or Added.
Root Schema : OrderTypeResponse
Type:
Show Source
object
-
hierUnitId:
integer
Unique hierarchy unit valueExample:
1
-
lineNum:
integer
Unique reference of the Order TypeExample:
1