Searches Customer Types by parameters
Searches Customer Types by parameters
Query Parameters
Order by.
Available field name values: id (default), active, name, default, modified_on
Available direction values: asc, desc.
Example: id asc, supplier desc
Filter by.
Available field name values: id, active, name, default, deleted, modified_since
In string values: ‘|’ and ‘,’ characters have to be escaped with slash, i.e. ‘\,’ ‘\|’
For operators that support multiple values (in, notin): multiple values are delimited using ‘|’ character
Available operators:
eq - Equal
neq - Not equals
lt - Less
lte - Less or equal
gt - Greater
gte - Greater or equal
in - In
notin - Not In
contains - Contains
isnull - Is Null
isnullorempty - Is Null Or Empty
isnotnull - Is Not Null
startswith - Starts with
endswith - Ends with
doesnotcontain - Does not contain
For non-nullable fields operators isnull and isnotnull are unavailable
For dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable
For strings operators: lt, lte, gt, gte are unavailable
Example: id:eq:303062
>= 1<= 100000
>= 1<= 2147483647
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
Paging Response with Customer Types data
V2.CustomerType.PagingResponse
Customer type model
Show Child Parameters
Query Parameters
Headers
Creates Customer Type
Sample request:
POST /customertypes
{
"name": "name",
"active": true,
"default": false
}
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Body
application/json
Body
Customer Type model
EmptyExample
Response
application/json
Response
Customer Type created
V2.CustomerType
Customer type model
Customer type identifier
Customer type name
>= 0 characters<= 60 characters
Customer type active
Customer type default
Customer type deleted
Customer type last modified
Headers
Body
Gets specific Customer Type by unique id
Gets specific Customer Type by unique id
Path Parameters
Customer type id
Example:10000
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
Returns found Customer Type
V2.CustomerType
Customer type model
Customer type identifier
Customer type name
>= 0 characters<= 60 characters
Customer type active
Customer type default
Customer type deleted
Customer type last modified
Path Parameters
Headers
Deletes specific Customer Type by id
Deletes specific Customer Type by id
Path Parameters
Customer Type id
Example:10000
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Response
Response
Customer Type deleted
Path Parameters
Headers
Updates Customer Type
Sample request:
PUT /customertypes
{
"name": "New customer type name",
"active": true,
"default": true,
"deleted": false
}
Path Parameters
Customer Type id
Example:10000
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Body
application/json
Body
Customer Type model
EmptyExample
Response
application/json
Response
Returns updated Customer Type
V2.CustomerType
Customer type model
Customer type identifier
Customer type name
>= 0 characters<= 60 characters
Customer type active
Customer type default
Customer type deleted
Customer type last modified