apply event on the order.

1min
PUT
This API will apply an event. If the event is transitionable, then the instance will transition to the particular state.
Path Parameters
orderId
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
PlatformOrderStateMachineStateUpdate
*
Description
Update platform order state machine configuration
eventCode
string
*
reasonCode
string
callback
Callback
Responses
200
OK
SuccessResponse
error
Error
*
request
Request
*
data
object
400
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
404
Error Occurred
GetErrorResponse
error
Error
*
request
Request
*
data
object
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{base_url}/core/api/v1/orders/state-machine/config/{orderId}/event' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "eventCode": ""
}'
curl --location --globoff --request PUT 'https://{base_url}/core/api/v1/orders/state-machine/config/{orderId}/event' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "eventCode": ""
}'
Responses
200
400
401
404
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
get state machine configuration for an order
apply event on the order.