Jump to

• Request
• Response

Get Sales Itemizers

post

/config/sim/v1/setup/getsalesitemizers

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

A request body for sales itemizer

Root Schema : SalesItemizerGetRequest

Type: object

Show Source

• include: string
  Objects included in response
• includeAll: string
  This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

  Example: detailed
• languages: string
  If specified, limits translated strings returned
• limit: integer
  If using paging, number of results returned in this page.
• offset: integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy: string
  Sorts the response by the specified field name and sort order.
• searchCriteria: string
  Search criteria to filter results based on field value

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Get response of sales itemizer

Body ()

Root Schema : SalesItemizerGetResponse

Type: object

Show Source

• count(required): integer
  Current response recount count.

  Example: 9
• hasMore(required): boolean
  Flag indicating if there are more objects to fetch.

  Example: true
• items(required): array items
  Array of Combo Meal Side objects of the organization.
• limit(required): integer
  Server page size

  Example: 10
• offset(required): integer
  Starting resource record index

  Example: 0
• totalResults(required): integer
  Total number of rows (excluding the paging parameters)

  Example: 100

{
    "type":"object",
    "required":[
        "totalResults",
        "hasMore",
        "count",
        "items",
        "offset",
        "limit"
    ],
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response recount count."
        },
        "items":{
            "type":"array",
            "description":"Array of Combo Meal Side objects of the organization.",
            "items":{
                "$ref":"#/definitions/SalesItemizer"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Combo Meal Side objects of the organization.

Show Source

• Array of: object SalesItemizer

{
    "type":"array",
    "description":"Array of Combo Meal Side objects of the organization.",
    "items":{
        "$ref":"#/definitions/SalesItemizer"
    }
}

Nested Schema : SalesItemizer

Type: object

Show Source

• hierUnitId(required): integer
  Unique reference of the hierarchy unit of the property

  Example: 1
• hierUnitName: object hierUnitName
  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum: integer
  Object number of the hierarchy unit

  Example: 1
• name(required): object name
  A group of string objects representing the name of the Sales Itemizers in configured languages
• salesItmzrIndex(required): integer
  Sequence number of the Sales Itemizer. Acceptable values are 1-16, including 1 and 16

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "salesItmzrIndex",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit of the property",
            "type":"integer",
            "example":1
        },
        "salesItmzrIndex":{
            "description":"Sequence number of the Sales Itemizer. Acceptable values are 1-16, including 1 and 16\n",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"A group of string objects representing the name of the Sales Itemizers in configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            }
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "hierUnitName":{
            "description":"A group of string objects representing the name of the hierarchy unit configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            }
        }
    }
}

Nested Schema : hierUnitName

Type: object

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

Nested Schema : name

Type: object

A group of string objects representing the name of the Sales Itemizers in configured languages

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

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