Search
K
Retail Express API 2.1

Searches Supplier Return Reasons by parameters

Searches Supplier Return Reasons by parameters

get
https://api.retailexpress.com.au/v2/supplierreturnreasons

Query Parameters

is_deletedboolean | null

Is deleted?

Leave it empty to get both deleted and not deleted Supplier Return Reasons

created_sincestring | null(date-time)

Created since

modified_sincestring | null(date-time)

Modified since

selectstring | null

Select fields.

Available field name values: id

Example: id

order_bystring | null

Order by.

Available field name values: id, name, created_on, modified_on.

Available direction values: asc, desc.

Example: id asc, name desc

page_numberinteger(int32)

Format - int32.

>= 1<= 100000

page_sizeinteger(int32)

Format - 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 Supplier Return Reasons data

SupplierReturnReasons.PagingResponse

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

Supplier Return Reason model

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

Updates Supplier Return Reason

Sample request:

 PUT /supplierreturnreasons
 {
     "name": "New Supplier Return Reason"
 }
put
https://api.retailexpress.com.au/v2/supplierreturnreasons/{id}

Path Parameters

idinteger(int32)required

Supplier Return Reason id

Example:1

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

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

Body

application/json

Supplier Return Reason model

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

Response

application/json

Returns updated Supplier Return Reason

SupplierReturnReasons

Supplier Return Reason model

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Return Reason Id.

namestringrequired

Supplier Return Reason name

>= 0 characters<= 50 characters

created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

deletedboolean

Is Supplier Return Reason deleted

Default:false

deleted_onstring | null(date-time)

Deleted on

put/supplierreturnreasons/{id}

Body

{}
 
application/json

Deletes Supplier Return Reason by id

Deletes Supplier Return Reason by id

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

Path Parameters

idinteger(int32)required

Supplier Return Reason id

Example:1

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

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

Response

Supplier Return Reason deleted

delete/supplierreturnreasons/{id}
 

Gets specific Supplier Return Reason by unique id

Gets specific Supplier Return Reason by unique id

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

Path Parameters

idinteger(int32)required

Supplier Return Reason id

Example:1

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 Supplier Return Reason

SupplierReturnReasons

Supplier Return Reason model

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Return Reason Id.

namestringrequired

Supplier Return Reason name

>= 0 characters<= 50 characters

created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

deletedboolean

Is Supplier Return Reason deleted

Default:false

deleted_onstring | null(date-time)

Deleted on

get/supplierreturnreasons/{id}
 
application/json

supplierreturns