idinteger(int32)required
Credit Note id
Example:1
Get Credit Note by id
Get Credit Note by id
get
https://api.retailexpress.com.au/v2.1/creditnotes/{id}
Path Parameters
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 Credit Note
CreditNote
Credit Note model
* Additional properties are NOT allowed.
idinteger | null(int32)
Credit Note id
supplier_return_idinteger | null(int32)
Supplier Return id
supplierobject
* Additional properties are NOT allowed.
Show Child Parameters
outletobject
* Additional properties are NOT allowed.
Show Child Parameters
supplier_referencestring | null
Supplier reference
>= 0 characters<= 50 characters
include_taxboolean | null
Include tax
Default:false
rounding_adjustmentnumber(double)
Rounding Adjustment
total_credit_quantityinteger(int32)
Total credit quantity
total_credit_amount_exnumber(double)
Total Credit Amount Ex
total_credit_amount_taxnumber(double)
Total Credit Amount Tax
total_credit_amount_incnumber(double)
Total Credit Amount Inc
total_applied_credit_quantityinteger(int32)
Total Applied Credit Quantity
total_applied_credit_amount_exnumber(double)
Total Applied Credit Amount Ex
total_applied_credit_amount_incnumber(double)
Total Applied Credit Amount Inc
total_applied_credit_taxnumber(double)
Total Applied Credit Tax
created_onstring(date-time)
Created on
modified_onstring(date-time)
Modified on
supplier_credited_onstring | null(date-time)
Supplier Credited On
created_byobject
* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject
* Additional properties are NOT allowed.
Show Child Parameters
get/creditnotes/{id}
Path Parameters
Headers
application/json
Searches Credit Note Items by parameters
Searches Credit Note Items by parameters
get
https://api.retailexpress.com.au/v2.1/creditnotes/{id}/creditnoteitems
Query Parameters
supplier_return_item_idsstring | null
Supplier Return Item id or collection of Supplier Return Item id (comma separated)
Example: 1,3,72,12
created_sincestring | null(date-time)
Created since
modified_sincestring | null(date-time)
Modified since
order_bystring | null
Order by.
Available field name values: id, credit_note_id, supplier_return_item_id, product_id, supplier_sku, manufacturer_sku, supplier_sku2, short_description, size, colour, credit_quantity, credit_amount_ex, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_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, credit_note_id desc
page_numberinteger(int32)
>= 1<= 100000
page_sizeinteger(int32)
>= 1<= 2147483647
Path Parameters
idinteger(int32)required
Credit Note 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
Credit Note Items returned successfully
CreditNoteItem.PagingResponse
* Additional properties are NOT allowed.
dataarray | null[object]
Credit Note model
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/creditnotes/{id}/creditnoteitems
Path Parameters
Query Parameters
Headers
application/json
Gets Credit Note Item by id
Gets Credit Note Item by id
get
https://api.retailexpress.com.au/v2.1/creditnotes/{id}/creditnoteitems/{item_id}
Path Parameters
idinteger(int32)required
Credit Note id
Example:1
item_idinteger(int32)required
Credit Note Item 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 Credit Note
CreditNoteItem
Credit Note model
* Additional properties are NOT allowed.
idinteger | null(int32)
Credit Note Item id
credit_note_idinteger(int32)
Credit Note id
supplier_return_item_idinteger | null(int32)
Supplier Return Item id
productobject
Product model for Credit Notes
* Additional properties are NOT allowed.
Show Child Parameters
credit_quantityinteger | null(int32)
Credit Quantity
credit_amount_exnumber | null(double)
Credit Amount Ex
total_credit_amount_exnumber | null(double)
Total Credit Amount Ex
applied_credit_quantityinteger | null(int32)
Applied Credit Quantity
applied_credit_taxnumber | null(double)
Applied Credit Tax
applied_credit_amount_incnumber | null(double)
Applied Credit Amount Inc
applied_credit_amount_exnumber | null(double)
Applied Credit Amount Ex
total_applied_credit_amount_exnumber | null(double)
Total Applied Credit Amount Ex
total_credit_amount_incnumber | null(double)
Total Credit Amount Inc
total_credit_amount_taxnumber | null(double)
Total Credit Amount Tax
total_applied_credit_amount_incnumber | null(double)
Total Applied Credit Amount Inc
total_applied_credit_taxnumber | null(double)
Total Applied Credit Tax
created_onstring(date-time)
Created on
modified_onstring(date-time)
Modified on
created_byobject
* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject
* Additional properties are NOT allowed.
Show Child Parameters
get/creditnotes/{id}/creditnoteitems/{item_id}
Path Parameters
Headers
application/json
currencies
Searches Currencies by parameters
Searches Currencies by parameters
get
https://api.retailexpress.com.au/v2.1/currencies
Query Parameters
modified_sincestring | null(date-time)
Modified since search parameter
order_bystring | null
Order by.
Available field name values: id (default), currency_code, currency_name, modified_on
Available direction values: asc, desc.
Example: description asc, modified_on desc
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
Paging Response with Currencies data
Currency.PagingResponse
* Additional properties are NOT allowed.
dataarray | null[object]
Currencies model
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/currencies
Query Parameters
Headers
application/json