Jump to

• Request
• Response

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.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string(string)
  Detail that Identifies that 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 TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages

{
    "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":{
            "$ref":"#/definitions/TranslatedString"
        },
        "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 : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A string that contains translations into multiple languages",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "es-MX":"Cafe"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages

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

Response object

Body ()

Root Schema : OrderTypeResponse

Type: object

Show Source

• hierUnitId(required): integer
  Unique hierarchy unit value

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

  Example: 1

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

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top