Search
K
Retail Express API 2.1

Searches Customer Types by parameters

Searches Customer Types by parameters

get
https://api.retailexpress.com.au/v2.1/customertypes

Query Parameters

order_bystring | null

Order by.

Available field name values: id (default), active, name, default, modified_on

Available direction values: asc, desc.

Example: id asc, supplier desc

filter_bystring | null

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

page_numberinteger(int32)

>= 1<= 100000

page_sizeinteger(int32)

>= 1<= 2147483647

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Response

application/json

Paging Response with Customer Types data

V2.CustomerType.PagingResponse

* Additional properties are NOT allowed.
dataarray | null[object]

Customer type model

* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/customertypes
 
application/json

Creates Customer Type

Sample request:

 POST /customertypes
 {
     "name": "name",
     "active": true,
     "default": false
 }
post
https://api.retailexpress.com.au/v2.1/customertypes

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Body

application/json

Customer Type model

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

Response

application/json

Customer Type created

V2.CustomerType

Customer type model

* Additional properties are NOT allowed.
idinteger(int32)

Customer type identifier

namestring | null

Customer type name

>= 0 characters<= 60 characters

activeboolean | null

Customer type active

defaultboolean | null

Customer type default

deletedboolean | null

Customer type deleted

modified_onstring(date-time)

Customer type last modified

post/customertypes

Body

{}
 
application/json

Gets specific Customer Type by unique id

Gets specific Customer Type by unique id

get
https://api.retailexpress.com.au/v2.1/customertypes/{id}

Path Parameters

idinteger(int32)required

Customer type id

Example:10000

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Response

application/json

Returns found Customer Type

V2.CustomerType

Customer type model

* Additional properties are NOT allowed.
idinteger(int32)

Customer type identifier

namestring | null

Customer type name

>= 0 characters<= 60 characters

activeboolean | null

Customer type active

defaultboolean | null

Customer type default

deletedboolean | null

Customer type deleted

modified_onstring(date-time)

Customer type last modified

get/customertypes/{id}
 
application/json

Deletes specific Customer Type by id

Deletes specific Customer Type by id

delete
https://api.retailexpress.com.au/v2.1/customertypes/{id}

Path Parameters

idinteger(int32)required

Customer Type id

Example:10000

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Response

Customer Type deleted

delete/customertypes/{id}
 

Updates Customer Type

Sample request:

 PUT /customertypes
 {
     "name": "New customer type name",
     "active": true,
     "default": true,
     "deleted": false
 }
put
https://api.retailexpress.com.au/v2.1/customertypes/{id}

Path Parameters

idinteger(int32)required

Customer Type id

Example:10000

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

Bearer token for authorization (e.g., Bearer )

Body

application/json

Customer Type model

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

Response

application/json

Returns updated Customer Type

V2.CustomerType

Customer type model

* Additional properties are NOT allowed.
idinteger(int32)

Customer type identifier

namestring | null

Customer type name

>= 0 characters<= 60 characters

activeboolean | null

Customer type active

defaultboolean | null

Customer type default

deletedboolean | null

Customer type deleted

modified_onstring(date-time)

Customer type last modified

put/customertypes/{id}

Body

{}
 
application/json