Retail Express API 2.1

supplierreturnitemstatus

Searches Supplier Return Item Statuses by parameters

Searches Supplier Return Item Statuses by parameters

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

Query Parameters

namestring | null

SupplierReturnItemStatus name.

order_bystring | null

Order by.

Available field name values: id, name.

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 Item Statuses data

SupplierReturnItemStatus.PagingResponse

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

Supplier Return Item Status Model

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

Gets specific Supplier Return Item Status by unique id

Gets specific Supplier Return Item Status by unique id

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

Path Parameters

idinteger(int32)required

Supplier Return Status 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 Item Status

SupplierReturnItemStatus

Supplier Return Item Status Model

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Return Item Status Id.

namestring | null

Supplier Return Item Status name

get/supplierreturnitemstatus/{id}
 
application/json

supplierreturnreasons

Creates Supplier Return Reason

Sample request:

 POST /supplierreturnreasons
 {
     "name": "Supplier Return Reason"
 }
post
https://api.retailexpress.com.au/v2/supplierreturnreasons

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

Supplier Return Reason created

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

post/supplierreturnreasons

Body

{}
 
application/json