Configuration and Content API Guide

Get Discount Itemizers

post

/config/sim/v1/sales/getdiscountitemizers

Gets all the Discount Itemizers configured

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

Show Source

include: string

Objects included in the response.

Example: hierUnitId
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 the translated strings returned.

Example: en-US, es-ES, es-MX
limit: integer

If using paging, number of results returned in this page.

Example: 0
offset: integer

Starting resource record index. Not required if paging parameters are not supported.

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value.

Example: where equals(objectNum,1)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the 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",
            "example":"en-US, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":0,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Discount Itemizers.

Root Schema : DiscountItemizersGetResponsev1

Type: object

Show Source

count: integer

Current response record count.

Example: 9
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of Discount Itemizer objects of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "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 record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Discount Itemizer objects of the organization.",
            "items":{
                "$ref":"#/definitions/DiscountItemizersResponsev1"
            }
        },
        "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 Discount Itemizer objects of the organization.

Show Source

Array of: object DiscountItemizersResponsev1

Model for Discount Itmzrs

{
    "type":"array",
    "description":"Array of Discount Itemizer objects of the organization.",
    "items":{
        "$ref":"#/definitions/DiscountItemizersResponsev1"
    }
}

Nested Schema : DiscountItemizersResponsev1

Type: object

Model for Discount Itmzrs

Show Source

dscItmzrIndex: integer

Object number of the Discount Itemizer

Example: 1
hierUnitId: 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: object name

A group of string objects representing the name of the Discounts Itmzrs in configured languages

{
    "description":"Model for Discount Itmzrs",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit of the property",
            "type":"integer",
            "example":1
        },
        "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"
            }
        },
        "dscItmzrIndex":{
            "description":"Object number of the Discount Itemizer",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"A group of string objects representing the name of the Discounts Itmzrs  in 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 Discounts Itmzrs in configured languages

Example:

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