Retail Express API 2.1

Gets Shipping Status by id

Gets Shipping Status by id

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

Path Parameters

idinteger(int32)required

Gets Shipping Status by 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 the Shipping Status

ShippingStatus

Shipping Status model

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

Identifier

namestring | null

name

>= 0 characters<= 50 characters

get/shippingstatus/{id}
 
application/json

Updates Shipping Status

Sample request:

 PUT /shippingstatus
 {
    "name": "Status A"
 }
put
https://api.retailexpress.com.au/v2.1/shippingstatus/{id}

Path Parameters

idinteger(int32)required

Shipping Status id

Example:100000

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

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

Body

application/json

Shipping Status model

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

Response

application/json

Returns updated Shipping Status

ShippingStatus

Shipping Status model

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

Identifier

namestring | null

name

>= 0 characters<= 50 characters

put/shippingstatus/{id}

Body

{}
 
application/json

Deletes Shipping Status by id

Deletes Shipping Status by id

delete
https://api.retailexpress.com.au/v2.1/shippingstatus/{id}

Path Parameters

idinteger(int32)required

Shipping Status id

Example:10000

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

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

Response

Shipping Status deleted

delete/shippingstatus/{id}
 

stockadjustmentreasons

Creates Stock Adjustment Reason

Sample request:

 POST /stockadjustmentreasons
 {
     "name": "Stock Adjustment Reason Name",
     "disabled": true
 }
post
https://api.retailexpress.com.au/v2.1/stockadjustmentreasons

Headers

x-api-keystringrequired

Api subscription key

Cache-Controlstring

Default:no-cache

Authorizationstringrequired

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

Body

application/json

Stock Adjustment Reason model

EmptyExample

EmptyExampleobject
* Additional properties are NOT allowed.

Response

application/json

Stock Adjustment Reason created

StockAdjustmentReason

Stock Adjustment Reason Model

* Additional properties are NOT allowed.
idinteger(int32)

Stock Adjustment Reason Id.

namestring | null

Stock Adjustment Reason name

disabledboolean

Stock Adjustment Reason disabled flag

created_onstring(date-time)

Stock Adjustment Reason creation date and time

modified_onstring(date-time)

Stock Adjustment Reason modification date and time

post/stockadjustmentreasons

Body

{}
 
application/json