Set A State Machine State For An Order

Transitions an order-related state machine to the specified state.

Overview

• Method: POST
• Path: /brand/order/set-state/<orderId>/<stateMachineType>
• Tags: brand

Parameters

orderId (path)

• Type: string
• Required: Yes
• Description: orderId parameter

stateMachineType (path)

• Type: string
• Required: Yes
• Description: stateMachineType parameter

Request Body

• Content Type: application/json
• Required: Yes

Fields

Responses

200

Successful response

Content Type: application/json

{
  "error": "string",
  "details": [
    {}
  ]
}

400

Bad Request

Content Type: application/json

{
  "error": "string",
  "details": [
    {}
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X POST \
  https://api.pillexa.com/brand/order/set-state/<orderId>/<stateMachineType> \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}'