WildApricot · JSON Structure

Wildapricot Order Structure

Order schema from WildApricot Admin API

Type: object Properties: 20 Required: 7
Membership ManagementAssociationsNonprofitEventsPayments

Order is a JSON Structure definition published by WildApricot, describing 20 properties, of which 7 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

url contactId number total subTotal isTaxesApplied isTaxesIncludedTotal invoiceId invoiceNumber status paymentStatus internalNote products shippingAddress billingPerson comment externalNote currency created deliveryOption

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wildapricot/refs/heads/main/json-structure/wildapricot-order-structure.json",
  "description": "Order schema from WildApricot Admin API",
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    },
    "contactId": {
      "type": "int32"
    },
    "number": {
      "type": "string"
    },
    "total": {
      "type": "double"
    },
    "subTotal": {
      "type": "double"
    },
    "isTaxesApplied": {
      "type": "boolean"
    },
    "isTaxesIncludedTotal": {
      "type": "boolean"
    },
    "invoiceId": {
      "type": "int32"
    },
    "invoiceNumber": {
      "type": "int32"
    },
    "status": {
      "$ref": "#/components/schemas/OrderStatus"
    },
    "paymentStatus": {
      "$ref": "#/components/schemas/PaymentStatus"
    },
    "internalNote": {
      "$ref": "#/components/schemas/OrderInternalNote"
    },
    "products": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderProduct"
      }
    },
    "shippingAddress": {
      "$ref": "#/components/schemas/ShippingAddress"
    },
    "billingPerson": {
      "$ref": "#/components/schemas/BillingPerson"
    },
    "comment": {
      "type": "string"
    },
    "externalNote": {
      "$ref": "#/components/schemas/OrderExternalNote"
    },
    "currency": {
      "$ref": "#/components/schemas/Currency"
    },
    "created": {
      "type": "datetime"
    },
    "deliveryOption": {
      "$ref": "#/components/schemas/OrderDeliveryOption"
    }
  },
  "required": [
    "contactId",
    "total",
    "subTotal",
    "isTaxesApplied",
    "isTaxesIncludedTotal",
    "status",
    "paymentStatus"
  ],
  "name": "Order"
}