ulams payments

ulams payments export

Export payments to file.

Kind: read (idempotent). Stability: stable. MCP tool: payments_export. Scopes: commerce:read.

Endpoints: GET /api/admin/payments/export.

Flag	Type	Required	Description
--order-by	string
--order	string
--status	string		Payment status
--order-id	string		External order id (e.g. from payment provider)
--payable-id	number		Id of payable (e.g. order model id)
--payable-type	string		Full classname of payable model (eg. Ulams\Cart\Models\Order)
--user-id	number		Id of user
--date-from	string		Date from
--date-to	string		Date to
--out	string		Write the download to this path (- for stdout)

# Export payments to file
ulams payments export --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "order_by": {
      "type": "string",
      "enum": [
        "created_at",
        "updated_at",
        "status",
        "payable_id",
        "user_id",
        "amount",
        "order_id",
        "id"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "new",
        "paid",
        "cancelled"
      ],
      "description": "Payment status"
    },
    "order_id": {
      "type": "string",
      "description": "External order id (e.g. from payment provider)"
    },
    "payable_id": {
      "type": "number",
      "description": "Id of payable (e.g. order model id)"
    },
    "payable_type": {
      "type": "string",
      "description": "Full classname of payable model (eg. Ulams\\Cart\\Models\\Order)"
    },
    "user_id": {
      "type": "number",
      "description": "Id of user"
    },
    "date_from": {
      "type": "string",
      "description": "Date from"
    },
    "date_to": {
      "type": "string",
      "description": "Date to"
    },
    "out": {
      "description": "Write the download to this path (- for stdout)",
      "type": "string"
    }
  },
  "additionalProperties": {}
}

ulams payments get

Display the specified Payment.

Kind: read (idempotent). Stability: stable. MCP tool: payments_get. Scopes: commerce:read.

Endpoints: GET /api/admin/payments/{id}.

Flag	Type	Required	Description
--id (positional)	integer	yes	id of Payment

# Display the specified Payment
ulams payments get 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of Payment"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams payments list

Search payments.

Kind: read (idempotent). Stability: stable. MCP tool: payments_list. Scopes: commerce:read.

Endpoints: GET /api/admin/payments.

Flag	Type	Required	Description
--order-by	string
--order	string
--page	number		Pagination Page Number
--per-page	number		Pagination Per Page
--status	string		Payment status
--order-id	string		External order id (e.g. from payment provider)
--payable-id	number		Id of payable (e.g. order model id)
--payable-type	string		Full classname of payable model (eg. Ulams\Cart\Models\Order)
--user-id	number		Id of user
--date-from	string		Date from
--date-to	string		Date to

# Search payments
ulams payments list --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "order_by": {
      "type": "string",
      "enum": [
        "created_at",
        "updated_at",
        "status",
        "payable_id",
        "user_id",
        "amount",
        "order_id",
        "id"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "page": {
      "type": "number",
      "description": "Pagination Page Number"
    },
    "per_page": {
      "type": "number",
      "description": "Pagination Per Page"
    },
    "status": {
      "type": "string",
      "enum": [
        "new",
        "paid",
        "cancelled"
      ],
      "description": "Payment status"
    },
    "order_id": {
      "type": "string",
      "description": "External order id (e.g. from payment provider)"
    },
    "payable_id": {
      "type": "number",
      "description": "Id of payable (e.g. order model id)"
    },
    "payable_type": {
      "type": "string",
      "description": "Full classname of payable model (eg. Ulams\\Cart\\Models\\Order)"
    },
    "user_id": {
      "type": "number",
      "description": "Id of user"
    },
    "date_from": {
      "type": "string",
      "description": "Date from"
    },
    "date_to": {
      "type": "string",
      "description": "Date to"
    }
  },
  "additionalProperties": {}
}