Jump to

• Request
• Response

Add Order Types

post

/config/sim/v1/setup/ordertypenames

Adds the Order Type Name

Release	Description
23.5	Starting from Simphony version 19.8, Add Order Types API will no longer be available.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

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 reference

  Example: 2
• lineNum(required): integer
  Line number of the Order Types

  Example: 1
• name(required): object name
  Name

{
    "description":"Model for Order Type CUD Request",
    "type":"object",
    "required":[
        "hierUnitId",
        "lineNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "lineNum":{
            "type":"integer",
            "example":1,
            "description":"Line number of the Order Types"
        },
        "name":{
            "type":"object",
            "description":"Name",
            "example":{
                "en-US":"Coffee",
                "de-DE":"Kaffee",
                "es-MX":"Cafe"
            }
        },
        "dataExtensions":{
            "description":"An array of data extensions for the Order Types",
            "type":"array",
            "items":{
                "$ref":"#/definitions/OrderType_dataExtentions"
            }
        }
    }
}

Nested Schema : dataExtensions

Type: array

An array of data extensions for the Order Types

Show Source

• Array of: object OrderType_dataExtentions

{
    "description":"An array of data extensions for the Order Types",
    "type":"array",
    "items":{
        "$ref":"#/definitions/OrderType_dataExtentions"
    }
}

Nested Schema : name

Type: object

Name

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}

Nested Schema : OrderType_dataExtentions

Type: object

Show Source

• columnName: string
  Name of the extention field

  Example: Extention Column 1
• value: string
  Value of the extention field

  Example: Value 1

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "example":"Value 1",
            "description":"Value of the extention field"
        },
        "columnName":{
            "type":"string",
            "example":"Extention Column 1",
            "description":"Name of the extention field"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Order Type Name Added.

Body ()

Root Schema : OrderTypeResponse

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• lineNum: integer
  Unique reference of the Order Type

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "lineNum":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the Order Type"
        }
    }
}

Back to Top