Search
K
Retail Express API 2.1

Get specific Supplier Return Item by Supplier Return id and Supplier Return Item id

Get specific Supplier Return Item by Supplier Return id and Supplier Return Item id

get
https://api.retailexpress.com.au/v2/supplierreturns/{id}/supplierreturnitems/{item_id}

Path Parameters

idinteger(int32)required

Supplier Return id

item_idinteger(int32)required

Supplier Return Item id

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

SupplierReturnItem

Supplier Return Item

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Return Item identifier

supplier_return_idinteger(int32)

Supplier Return id

productobject

Supplier Return Item Product Model

* Additional properties are NOT allowed.
Show Child Parameters
supplier_return_reasonobject

Supplier Return Reason model

* Additional properties are NOT allowed.
Show Child Parameters
credit_note_itemobject

Supplier Return Item Credit Note Item Model

* Additional properties are NOT allowed.
Show Child Parameters
return_quantityinteger | null(int32)

Return Quantity

original_buy_exnumber | null(double)

Supplier price ex

total_original_buy_exnumber | null(double)

Total supplier buy ex

supplier_return_item_statusobject

Supplier Return Item Status Model

* Additional properties are NOT allowed.
Show Child Parameters
supplier_return_item_sourceobject

Supplier Return Item Product Model

* Additional properties are NOT allowed.
Show Child Parameters
original_supplier_invoicestring | null

Supplier invoice number

claim_amount_exnumber | null(double)

Claim amount ex

supplier_return_item_notesstring | null

Notes

total_claim_amount_exnumber | null(double)

Total claim amount ex

total_claim_amount_taxnumber | null(double)

Total claim amount tax

total_claim_amount_incnumber | null(double)

Total claim amount inc

created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

created_byobject

User Model

* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject

User Model

* Additional properties are NOT allowed.
Show Child Parameters
get/supplierreturns/{id}/supplierreturnitems/{item_id}
 
application/json

Deletes specific Supplier Return Item by id

Deletes specific Supplier Return Item by id

delete
https://api.retailexpress.com.au/v2/supplierreturns/{id}/supplierreturnitems/{item_id}

Path Parameters

idinteger(int32)required

Supplier Return Id

item_idinteger(int32)required

Supplier Return Item Id

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

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

Response

Supplier Return Item was deleted

delete/supplierreturns/{id}/supplierreturnitems/{item_id}
 

Updates Supplier Return Item

Sample request:

 PUT /supplierreturn​/1/supplierreturnitems/1
 {
     "product": {
         "id": 1
     },
     "supplier_return_reason": {
         "id": 1
     },
     "return_quantity": 1,
     "original_buy_ex": 1.1,
     "claim_amount_ex": 1.1,
     "supplier_return_item_status": {
         "id": 1
     },
     "supplier_return_item_source": {
          "id": 1
     },
     "original_supplier_invoice": "original supplier invoice",
     "supplier_return_item_notes": "notes"
  }
put
https://api.retailexpress.com.au/v2/supplierreturns/{id}/supplierreturnitems/{item_id}

Path Parameters

idinteger(int32)required

Supplier Return id

item_idinteger(int32)required

Supplier Return Item id

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 Item model

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

Response

application/json

Returns updated Supplier Return Item

SupplierReturnItem

Supplier Return Item

* Additional properties are NOT allowed.
idinteger(int32)

Supplier Return Item identifier

supplier_return_idinteger(int32)

Supplier Return id

productobject

Supplier Return Item Product Model

* Additional properties are NOT allowed.
Show Child Parameters
supplier_return_reasonobject

Supplier Return Reason model

* Additional properties are NOT allowed.
Show Child Parameters
credit_note_itemobject

Supplier Return Item Credit Note Item Model

* Additional properties are NOT allowed.
Show Child Parameters
return_quantityinteger | null(int32)

Return Quantity

original_buy_exnumber | null(double)

Supplier price ex

total_original_buy_exnumber | null(double)

Total supplier buy ex

supplier_return_item_statusobject

Supplier Return Item Status Model

* Additional properties are NOT allowed.
Show Child Parameters
supplier_return_item_sourceobject

Supplier Return Item Product Model

* Additional properties are NOT allowed.
Show Child Parameters
original_supplier_invoicestring | null

Supplier invoice number

claim_amount_exnumber | null(double)

Claim amount ex

supplier_return_item_notesstring | null

Notes

total_claim_amount_exnumber | null(double)

Total claim amount ex

total_claim_amount_taxnumber | null(double)

Total claim amount tax

total_claim_amount_incnumber | null(double)

Total claim amount inc

created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

created_byobject

User Model

* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject

User Model

* Additional properties are NOT allowed.
Show Child Parameters
put/supplierreturns/{id}/supplierreturnitems/{item_id}

Body

{}
 
application/json

Creates Credit Note with Credit Note Items

Sample request:

 POST ​​/supplierreturn​/{id}​/creditnotes
 {
     "supplier_reference": "supplier_reference",
     "credit_note_items": [
          {
              "supplier_return_item_id": 1
          },
          {
              "supplier_return_item_id": 2
          }
     ]
 }
post
https://api.retailexpress.com.au/v2/supplierreturns/{id}/creditnotes

Path Parameters

idinteger(int32)required

Supplier Return id

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

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

Body

application/json

Credit Note to be created

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

Response

application/json

Credit Note model with Credit Note Items were created

SupplierReturnsCreditNote

Credit Note model for ​/supplierreturn​/{id}​/creditnotes endpoint

* Additional properties are NOT allowed.
idinteger | null(int32)

Credit Note id

supplier_return_idinteger | null(int32)

Supplier Return id

supplierobject

Supplier model for Credit Notes

* Additional properties are NOT allowed.
Show Child Parameters
outletobject

Outlet model for Credit Notes

* Additional properties are NOT allowed.
Show Child Parameters
supplier_referencestring | null

Supplier reference

>= 0 characters<= 50 characters

include_taxboolean | null

Include tax

Default:false

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

credit_note_itemsarray | null[object]

Supplier returns Credit Note item model

* Additional properties are NOT allowed.
Show Child Parameters
created_onstring(date-time)

Created on

modified_onstring(date-time)

Modified on

created_byobject

Credit Note User

* Additional properties are NOT allowed.
Show Child Parameters
modified_byobject

Credit Note User

* Additional properties are NOT allowed.
Show Child Parameters
post/supplierreturns/{id}/creditnotes

Body

{}
 
application/json

Searches Supplier Return Credit Notes by parameters

Searches Supplier Return Credit Notes by parameters

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

Query Parameters

idsstring | null

Сredit note Ids. (comma separated)
Other properties are skipped, if used.
Example: 2,3,4

supplier_referencestring | null

Supplier reference.

created_sincestring | null(date-time)

Created since

modified_sincestring | null(date-time)

Modified since

order_bystring | null

Order by.

Available field name values: id, supplier_return_id, supplier, outlet, supplier_reference, total_credit_quantity, 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, supplier_reference desc

page_numberinteger(int32)

Format - int32.

>= 1<= 100000

page_sizeinteger(int32)

Format - int32.

>= 1<= 2147483647

Path Parameters

idinteger(int32)required

Supplier Return id

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 Credit Notes data

SupplierReturnsCreditNote.PagingResponse

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

Credit Note model for ​/supplierreturn​/{id}​/creditnotes endpoint

* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/supplierreturns/{id}/creditnotes
 
application/json