← Blog

WooCommerce order data schema

Forms Bridge utilizes JSON Schemas to describe settings and perform data validations.

An example of this use is the WooCommerce order schema that defines the structure of the order data:

{
    "type": "object",
    "properties": {
        "id": {
            "type": "integer"
        },
        "parent_id": {
            "type": "integer"
        },
        "status": {
            "type": "string"
        },
        "currency": {
            "type": "string"
        },
        "version": {
            "type": "string"
        },
        "prices_include_tax": {
            "type": "boolean"
        },
        "date_created": {
            "type": "string"
        },
        "date_modified": {
            "type": "string"
        },
        "discount_total": {
            "type": "number"
        },
        "discount_tax": {
            "type": "object",
            "properties": {
                "amount": {
                    "type": "number"
                },
                "rate": {
                    "type": "number"
                },
                "percentage": {
                    "type": "number"
                }
            }
        },
        "shipping_total": {
            "type": "number"
        },
        "shipping_tax": {
            "type": "object",
            "properties": {
                "amount": {
                    "type": "number"
                },
                "rate": {
                    "type": "number"
                },
                "percentage": {
                    "type": "number"
                }
            }
        },
        "cart_total": {
            "type": "number"
        },
        "cart_tax": {
            "type": "object",
            "properties": {
                "amount": {
                    "type": "number"
                },
                "rate": {
                    "type": "number"
                },
                "percentage": {
                    "type": "number"
                }
            }
        },
        "total": {
            "type": "number"
        },
        "total_tax": {
            "type": "object",
            "properties": {
                "amount": {
                    "type": "number"
                },
                "rate": {
                    "type": "number"
                },
                "percentage": {
                    "type": "number"
                }
            }
        },
        "customer_id": {
            "type": "integer"
        },
        "order_key": {
            "type": "string"
        },
        "billing": {
            "type": "object",
            "properties": {
                "first_name": {
                    "type": "string"
                },
                "last_name": {
                    "type": "string"
                },
                "company": {
                    "type": "string"
                },
                "address_1": {
                    "type": "string"
                },
                "address_2": {
                    "type": "string"
                },
                "city": {
                    "type": "string"
                },
                "state": {
                    "type": "string"
                },
                "postcode": {
                    "type": "string"
                },
                "country": {
                    "type": "string"
                },
                "email": {
                    "type": "string"
                },
                "phone": {
                    "type": "string"
                }
            },
            "additionalProperties": true
        },
        "shipping": {
            "type": "object",
            "properties": {
                "first_name": {
                    "type": "string"
                },
                "last_name": {
                    "type": "string"
                },
                "company": {
                    "type": "string"
                },
                "address_1": {
                    "type": "string"
                },
                "address_2": {
                    "type": "string"
                },
                "city": {
                    "type": "string"
                },
                "state": {
                    "type": "string"
                },
                "postcode": {
                    "type": "string"
                },
                "country": {
                    "type": "string"
                },
                "phone": {
                    "type": "string"
                }
            },
            "additionalProperties": true
        },
        "payment_method": {
            "type": "string"
        },
        "payment_method_title": {
            "type": "string"
        },
        "transaction_id": {
            "type": "string"
        },
        "customer_ip_address": {
            "type": "string"
        },
        "customer_user_agent": {
            "type": "string"
        },
        "created_via": {
            "type": "string"
        },
        "customer_note": {
            "type": "string"
        },
        "date_completed": {
            "type": "string"
        },
        "date_paid": {
            "type": "string"
        },
        "cart_hash": {
            "type": "string"
        },
        "order_stock_reduced": {
            "type": "boolean"
        },
        "download_permissions_granted": {
            "type": "boolean"
        },
        "new_order_email_sent": {
            "type": "boolean"
        },
        "recorded_sales": {
            "type": "boolean"
        },
        "recorded_coupon_usage_counts": {
            "type": "boolean"
        },
        "number": {
            "type": "integer"
        },
        "line_items": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer"
                    },
                    "order_id": {
                        "type": "integer"
                    },
                    "name": {
                        "type": "string"
                    },
                    "product_id": {
                        "type": "integer"
                    },
                    "variation_id": {
                        "type": "integer"
                    },
                    "quantity": {
                        "type": "integer"
                    },
                    "tax_class": {
                        "type": "string"
                    },
                    "subtotal": {
                        "type": "number"
                    },
                    "subtotal_tax": {
                        "type": "object",
                        "properties": {
                            "amount": {
                                "type": "number"
                            },
                            "rate": {
                                "type": "number"
                            },
                            "percentage": {
                                "type": "number"
                            }
                        }
                    },
                    "total": {
                        "type": "number"
                    },
                    "total_tax": {
                        "type": "object",
                        "properties": {
                            "amount": {
                                "type": "number"
                            },
                            "rate": {
                                "type": "number"
                            },
                            "percentage": {
                                "type": "number"
                            }
                        }
                    },
                    "taxes": {
                        "type": "object",
                        "properties": {
                            "subtotal": {
                                "type": "array",
                                "items": {
                                    "type": "number"
                                },
                                "additionalItems": true
                            },
                            "total": {
                                "type": "array",
                                "items": {
                                    "type": "number"
                                },
                                "additionalItems": true
                            }
                        }
                    },
                    "product": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "integer"
                            },
                            "parent_id": {
                                "type": "integer"
                            },
                            "sku": {
                                "type": "string"
                            },
                            "name": {
                                "type": "string"
                            },
                            "slug": {
                                "type": "string"
                            },
                            "price": {
                                "type": "number"
                            },
                            "sale_price": {
                                "type": "number"
                            },
                            "regular_price": {
                                "type": "number"
                            },
                            "stock_quantity": {
                                "type": "number"
                            },
                            "stock_status": {
                                "type": "string"
                            }
                        }
                    },
                    "tax_total": {
                        "type": "number"
                    },
                    "shipping_tax_total": {
                        "type": "number"
                    },
                    "rate_percent": {
                        "type": "number"
                    }
                }
            },
            "additionalItems": true
        },
        "shipping_lines": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer"
                    },
                    "order_id": {
                        "type": "integer"
                    },
                    "name": {
                        "type": "string"
                    },
                    "method_id": {
                        "type": "string"
                    },
                    "method_title": {
                        "type": "string"
                    },
                    "instance_id": {
                        "type": "integer"
                    },
                    "total": {
                        "type": "number"
                    },
                    "total_tax": {
                        "type": "object",
                        "properties": {
                            "amount": {
                                "type": "number"
                            },
                            "rate": {
                                "type": "number"
                            },
                            "percentage": {
                                "type": "number"
                            }
                        }
                    },
                    "tax_status": {
                        "type": "string"
                    },
                    "taxes": {
                        "type": "object",
                        "properties": {
                            "total": {
                                "type": "number"
                            },
                            "subtotal": {
                                "type": "number"
                            }
                        },
                        "required": [
                            "total"
                        ]
                    }
                }
            },
            "additionalItems": true
        },
        "fee_lines": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer"
                    },
                    "order_id": {
                        "type": "integer"
                    },
                    "name": {
                        "type": "string"
                    },
                    "tax_class": {
                        "type": "string"
                    },
                    "tax_status": {
                        "type": "string"
                    },
                    "amount": {
                        "type": "number"
                    },
                    "total": {
                        "type": "number"
                    },
                    "total_tax": {
                        "type": "object",
                        "properties": {
                            "amount": {
                                "type": "number"
                            },
                            "rate": {
                                "type": "number"
                            },
                            "percentage": {
                                "type": "number"
                            }
                        }
                    },
                    "taxes": {
                        "type": "object",
                        "properties": {
                            "total": {
                                "type": "array",
                                "items": {
                                    "type": "number"
                                },
                                "additionalItems": true
                            }
                        },
                        "required": [
                            "total"
                        ]
                    }
                }
            },
            "additionalItems": true
        },
        "coupon_lines": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer"
                    },
                    "order_id": {
                        "type": "integer"
                    },
                    "name": {
                        "type": "string"
                    },
                    "code": {
                        "type": "string"
                    },
                    "discount": {
                        "type": "number"
                    },
                    "discount_tax": {
                        "type": "number"
                    }
                }
            },
            "additionalItems": true
        }
    },
    "additionalProperties": false
}

And this is an example of a fulfilled order data:

{
    "id": 3668,
    "parent_id": 0,
    "status": "completed",
    "currency": "EUR",
    "version": "9.8.5",
    "prices_include_tax": false,
    "date_created": "2025-05-30T00:04:11+00:00",
    "date_modified": "2025-05-31T10:46:35+00:00",
    "discount_total": 0,
    "discount_tax": {
      "amount": 0,
      "rate": 0,
      "percentage": 0
    },
    "shipping_total": 10,
    "shipping_tax": {
      "amount": 2.1,
      "rate": 0.21,
      "percentage": 21
    },
    "cart_total": 100,
    "cart_tax": {
      "amount": 21,
      "rate": 0.21,
      "percentage": 21
    },
    "total": 133.1,
    "total_tax": {
      "amount": 23.1,
      "rate": 0.231,
      "percentage": 23.1
    },
    "customer_id": 1,
    "order_key": "wc_order_mTIQF95dFRTsz",
    "billing": {
        "first_name": "Bob",
        "last_name": "Alice",
        "company": "",
        "address_1": "Street",
        "address_2": "",
        "city": "City",
        "state": "B",
        "postcode": "08000",
        "country": "ES",
        "email": "admin@wp.local",
        "phone": "600000000"
    },
    "shipping": {
        "first_name": "Bob",
        "last_name": "Alice",
        "company": "",
        "address_1": "Street",
        "address_2": "",
        "city": "City",
        "state": "B",
        "postcode": "08001",
        "country": "ES",
        "phone": ""
    },
    "payment_method": "cod",
    "payment_method_title": "Cash on delivery",
    "customer_ip_address": "172.23.0.1",
    "customer_user_agent": "Mozilla\/5.0 (X11; Linux x86_64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/136.0.0.0 Safari\/537.36",
    "created_via": "store-api",
    "customer_note": "Foo bar",
    "date_completed": "2025-05-31T10:46:35+00:00",
    "date_paid": "2025-05-30T00:06:34+00:00",
    "cart_hash": "6e282819d75f93af17eea9e0d8e72c32",
    "order_stock_reduced": true,
    "download_permissions_granted": true,
    "new_order_email_sent": false,
    "recorded_sales": true,
    "recorded_coupon_usage_counts": true,
    "number": 3668,
    "line_items": [
        {
            "id": 67,
            "order_id": 3668,
            "name": "aaa Size L Red",
            "product_id": 2991,
            "variation_id": 0,
            "quantity": 10,
            "tax_class": "",
            "subtotal": 100,
            "subtotal_tax": {
              "amount": 21,
              "rate": 0.21,
              "percentage": 21.0
            },
            "total": 100,
            "total_tax": {
              "amount": 21,
              "rate": 0.21,
              "percentage": 21.0
            },
            "taxes": {
                "total": [
                    21
                ],
                "subtotal": [
                    21
                ]
            },
            "product": {
                "id": 2991,
                "parent_id": 0,
                "slug": "aaa_l_red",
                "sku": "DESK0005",
                "name": "aaa Size L Red",
                "price": 10,
                "sale_price": 0,
                "regular_price": 10
            }
        }
    ],
    "tax_lines": [
        {
            "id": 71,
            "order_id": 3668,
            "name": "",
            "rate_code": "ES-IVA-1",
            "rate_id": 1,
            "label": "IVA",
            "compound": false,
            "tax_total": 21,
            "shipping_tax_total": 2.1,
            "rate_percent": 21
        }
    ],
    "shipping_lines": [
        {
            "id": 72,
            "order_id": 3668,
            "name": "Flat rate",
            "method_title": "Flat rate",
            "method_id": "flat_rate",
            "instance_id": 1,
            "total": 10,
            "total_tax": 2.1,
            "taxes": {
                "total": 1
            },
            "tax_status": "taxable"
        }
    ],
    "fee_lines": [],
    "coupon_lines": [],
    "lang": "en_US",
    "state": "sale"
}

This is an example representation of the available data in the WooCommerce bridge workflows. This is a huge payload and you will rarely require all this data as your bridge payload.