idinteger(int32)required
Supplier Return Reason id
Example:1
Updates Supplier Return Reason
Sample request:
PUT /supplierreturnreasons
{
"name": "New Supplier Return Reason"
}
put
https://api.retailexpress.com.au/v2.1/supplierreturnreasons/{id}
Path Parameters
Headers
x-api-keystringrequired
Api subscription key
Cache-Controlstring
Default:no-cache
Authorizationstringrequired
Bearer token for authorization (e.g., Bearer )
Body
application/json
Body
application/json
Supplier Return Reason model
EmptyExample
EmptyExampleobject
* Additional properties are NOT allowed.
Response
application/json
Response
application/json
Returns updated Supplier Return Reason
SupplierReturnReasons
Supplier Return Reason model
* Additional properties are NOT allowed.
idinteger | null(int32)
Supplier Return Reason Id.
namestring | null
Supplier Return Reason name
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}
Path Parameters
Headers
Body
{}
application/json
Deletes Supplier Return Reason by id
Deletes Supplier Return Reason by id
delete
https://api.retailexpress.com.au/v2.1/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
Response
Supplier Return Reason deleted
delete/supplierreturnreasons/{id}
Path Parameters
Headers
Gets specific Supplier Return Reason by unique id
Gets specific Supplier Return Reason by unique id
get
https://api.retailexpress.com.au/v2.1/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
Response
application/json
Returns found Supplier Return Reason
SupplierReturnReasons
Supplier Return Reason model
* Additional properties are NOT allowed.
idinteger | null(int32)
Supplier Return Reason Id.
namestring | null
Supplier Return Reason name
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}
Path Parameters
Headers
application/json
supplierreturns
Searches Supplier Returns by parameters
Searches Supplier Returns by parameters
get
https://api.retailexpress.com.au/v2.1/supplierreturns
Query Parameters
idsstring | null
List of supplier returns identifiers
Example: 2,3,4
supplier_idsstring | null
List of supplier identifiers
Example: 2,3,4
outlet_idsstring | null
List of outlet identifiers
Example: 2,3,4
supplier_return_status_idsstring | null
List of Supplier Return Status identifiers
Example: 2,3,4
created_sincestring | null(date-time)
Created since
modified_sincestring | null(date-time)
Modified since
include_credit_notesboolean
Include Credit Notes flag
order_bystring | null
Order by.
Available field name values: id, supplier, outlet, supplier_return_status, return_authorisation, total_return_quantity, total_claim_amount_ex, total_claim_amount_tax, total_claim_amount_inc, total_credit_received_ex, total_credit_received_inc, created_on, started_on, modified_on, finalised_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname.
Available direction values: asc, desc.
Example: id asc, supplier desc
filter_bystring | null
Filter by.
Available field name values: id, supplier, outlet, supplier_return_status, return_authorisation, created_on, started_on, finalised_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, total_return_quantity, total_claim_amount_ex, total_claim_amount_tax, total_claim_amount_inc, total_credit_received_ex, total_credit_received_inc, credit_note_number (for value, matches id or supplier_reference of any of credit_notes linked to Supplier Return. Supported operators are eq, neq, contains, doesnotcontain, in, notin)
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: created_on:gte:2021-06-03T05:48:09+10:00,supplier:in:supplier1|supplier2
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
Response
application/json
Returns Supplier Returns
SupplierReturns.PagingResponse
* Additional properties are NOT allowed.
dataarray | null[object]
Supplier Returns VM
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/supplierreturns
Query Parameters
Headers
application/json