Retail Express API 2.1

Updates Supplier Invoice Direct Costs

Sample request:

PUT /supplierinvoices/1/directcosts
{
    "freight":
    {
        "total_ex": 10,
        "includes_tax": false
    },
    "misc":
    {
        "total_ex": 32.1,
        "includes_tax": true
    },
    "duty":
    {
        "total_ex": 20.5
    }
}
put
https://api.retailexpress.com.au/v2.1/supplierinvoices/{id}/directcosts

Path Parameters

idinteger(int32)required

Supplier Invoice 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 Invoice Direct Costs model

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

Response

application/json

Supplier Invoice Direct Costs updated

SupplierInvoiceDirectCosts

Supplier Invoice Direct Costs Model

* Additional properties are NOT allowed.
applied_onstring | null(date-time)

DirectCosts AppliedOn

apply_pendingboolean

Is DirectCosts Apply Pending

freightobject

Direct Costs Item model

* Additional properties are NOT allowed.
Show Child Parameters
dutyobject

Direct Costs Item model

* Additional properties are NOT allowed.
Show Child Parameters
miscobject

Direct Costs Item model

* Additional properties are NOT allowed.
Show Child Parameters
put/supplierinvoices/{id}/directcosts

Body

{}
 
application/json

supplierreturnitemsource

Searches Supplier Return Item Sources by parameters

Searches Supplier Return Item Sources by parameters

get
https://api.retailexpress.com.au/v2.1/supplierreturnitemsource

Query Parameters

namestring | null

Supplier Return Item source 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)

>= 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

Paging Response with Supplier Return Item Sources data

SupplierReturnItemSource.PagingResponse

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

Supplier Return Item Product Model

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

Gets specific Supplier Return Item Source by unique id

Gets specific Supplier Return Item Source by unique id

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

Path Parameters

idinteger(int32)required

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

SupplierReturnItemSource

Supplier Return Item Product Model

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

Supplier Return Item source Id.

namestring | null

Supplier Return Item source name

get/supplierreturnitemsource/{id}
 
application/json

supplierreturnitemstatus