Skip to content

OrderActivity ​

Type: schema

TypeScript Definition ​

typescript
OrderActivity: {{
            /** @description `null` when the activity was written without one — the create-activity endpoint requires only `comment`. */
            activity_type?: $Read<string | null>;
            /** @description Outcome of the activity, e.g. `success`. */
            status?: $Read<string>;
            comment: string;
            /** @description Extra context for the activity as key/value pairs, e.g. the payment request number. `null` when the activity carries none. */
            details?: $Read<{
                key?: string;
                value?: string;
            }[] | null>;
            /** @enum {unknown} */
            user_type?: $Read<"customer" | "admin" | "system">;
            user_name?: $Read<string | null>;
            /** Format: date-time */
            created_at?: $Read<string>;
            /** Format: date-time */
            modified_at?: $Read<string>;
        };
        /**
         * OrderAddress
         * @description A billing or shipping address as recorded on the order: a copy made when the order was placed, so later changes to the customer's saved addresses don't alter it. Its fields are `null` when the order was placed without them (e.g. at a point of sale).
         */
}

OpenAPI Schema ​

json
{
  "type": "object",
  "properties": {
    "activity_type": {
      "description": "`null` when the activity was written without one — the create-activity endpoint requires only `comment`.",
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "status": {
      "description": "Outcome of the activity, e.g. `success`.",
      "type": "string",
      "readOnly": true
    },
    "comment": {
      "type": "string"
    },
    "details": {
      "description": "Extra context for the activity as key/value pairs, e.g. the payment request number. `null` when the activity carries none.",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "readOnly": true
    },
    "user_type": {
      "enum": [
        "customer",
        "admin",
        "system"
      ],
      "readOnly": true
    },
    "user_name": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "required": [
    "comment"
  ],
  "title": "OrderActivity",
  "x-tags": [
    "Orders"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: