ulams orders

ulams orders export

Export orders to file.

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

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

Flag	Type	Required	Description
--order-by	string
--order	string
--user-id	integer		User (buyer) ID
--product-id	integer		Product ID
--productable-id	integer		Productable ID (for example Course Id)
--productable-type	string		Productable type (class) - required if productable_id is sent
--status	integer		Status (0 = PROCESSING, 1 = PAID, 2 = CANCELLED)
--format	string		File format
--out	string		Write the download to this path (- for stdout)

# Export orders to file
ulams orders 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",
        "user_id"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "user_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "User (buyer) ID"
    },
    "product_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Product ID"
    },
    "productable_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Productable ID (for example Course Id)"
    },
    "productable_type": {
      "type": "string",
      "description": "Productable type (class) - required if productable_id is sent"
    },
    "status": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Status (0 = PROCESSING, 1 = PAID, 2 = CANCELLED)"
    },
    "format": {
      "type": "string",
      "enum": [
        "csv",
        "xlsx",
        "xls"
      ],
      "description": "File format"
    },
    "out": {
      "description": "Write the download to this path (- for stdout)",
      "type": "string"
    }
  },
  "additionalProperties": {}
}

ulams orders get

Display the specified Order.

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

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

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

# Display the specified Order
ulams orders 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 Order"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams orders list

Search orders.

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

Endpoints: GET /api/admin/orders.

Flag	Type	Required	Description
--order-by	string
--order	string
--page	integer		Pagination Page Number
--per-page	integer		Pagination Per Page
--user-id	integer		User (buyer) ID
--product-id	integer		Product ID
--productable-id	integer		Productable ID (for example Course Id)
--productable-type	string		Productable type (class) - required if productable_id is sent
--status	integer		Status (0 = PROCESSING, 1 = PAID, 2 = CANCELLED)

# Search orders
ulams orders 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",
        "user_id"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Pagination Page Number"
    },
    "per_page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Pagination Per Page"
    },
    "user_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "User (buyer) ID"
    },
    "product_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Product ID"
    },
    "productable_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Productable ID (for example Course Id)"
    },
    "productable_type": {
      "type": "string",
      "description": "Productable type (class) - required if productable_id is sent"
    },
    "status": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Status (0 = PROCESSING, 1 = PAID, 2 = CANCELLED)"
    }
  },
  "additionalProperties": {}
}