Run Macro

Execute a macro for an order and run subsequent state transitions.

Overview

• Method: POST
• Path: /brand/macros/run-macro/<orderId>/<macroId>
• Tags: brand

Parameters

orderId (path)

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

macroId (path)

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

Request Body

• Content Type: application/json
• Required: Yes

Fields

Responses

200

Successful response

Content Type: application/json

{
  "isSuccessful": true,
  "macroRun": "string",
  "data": {
    "key": {}
  },
  "createdAt": "2024-01-01T00:00:00.000Z"
}

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/macros/run-macro/<orderId>/<macroId> \
  -H "Content-Type: application/json" \
  -d '{"example": "data"}'