order
General
Statemachinetype

Set A State Machine State For An Order

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

Overview

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

Parameters

orderId (path)

  • Type: string
  • Required: Yes
  • Description: No description

stateMachineType (path)

  • Type: string
  • Required: Yes
  • Description: No description

Request Body

  • Content Type: application/json
  • Required: Yes

Fields

FieldTypeRequiredDetails
stateNamestringYesminLength: 1

Responses

200

Success

400

Validation error

Content Type: application/json

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

Example Usage

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