namestring | null
Name
page_numberinteger(int32)
>= 1<= 100000
page_sizeinteger(int32)
>= 1<= 2147483647
Searches Shipping Statuses by parameters
Searches Shipping Statuses by parameters
get
https://api.retailexpress.com.au/v2.1/shippingstatus
Query 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
Paging Response with Shipping Statuses data
ShippingStatus.PagingResponse
* Additional properties are NOT allowed.
dataarray | null[object]
Shipping Status model
* Additional properties are NOT allowed.
Show Child Parameters
page_numberinteger(int32)
page_sizeinteger(int32)
total_recordsinteger(int32)
get/shippingstatus
Query Parameters
Headers
application/json
Creates Shipping Status
Sample request:
POST /shippingstatus
{
"name": "Test name"
}
post
https://api.retailexpress.com.au/v2.1/shippingstatus
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
Shipping Status to be created
EmptyExample
EmptyExampleobject
* Additional properties are NOT allowed.
Response
application/json
Response
application/json
Shipping Status created
ShippingStatus
Shipping Status model
* Additional properties are NOT allowed.
idinteger | null(int32)
Identifier
namestring | null
name
>= 0 characters<= 50 characters
post/shippingstatus
Headers
Body
{}
application/json
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
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}
Path Parameters
Headers
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
Body
application/json
Shipping Status model
EmptyExample
EmptyExampleobject
* Additional properties are NOT allowed.
Response
application/json
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}
Path Parameters
Headers
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
Response
Shipping Status deleted
delete/shippingstatus/{id}