Order_custom_field.dtd

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"id": "https://github.com/route4me/route4me-json-schemas/blob/master/Order_custom_field.dtd",
	"title": "Order",
	"description": "JSON schema for Order Custom Filed query response. Endpoint: https://api.route4me.com/api.v4/order_custom_user_fields.php",
	"type": "object",
	"properties": {
		"order_custom_field_id": {
			"type": "integer",
			"title": "Order Custom Field ID",
			"description": "Order custom field ID."
		},
		"order_custom_field_name": {
			"type": "string",
			"title": "Order Custom Field Name",
			"description": "Order custom field name"
		},
		"order_custom_field_label": {
			"type": "string",
			"title": "Order Custom Field Label",
			"description": "Order custom field label"
		},
		"order_custom_field_type": {
			"type": "string",
			"title": "Order Custom Field Type",
			"description": "Order custom field type (default: 'checkbox')"
		},
		"order_custom_field_value": {
			"type": "string",
			"title": "Order Custom Field Value",
			"description": "Order custom field value. If order_custom_field_type='checkbox', valid values are: 'true', 'false'."
		},
		"root_owner_member_id": {
			"type": "integer",
			"title": "Root Owner Member ID",
			"description": "Root owner member ID"
		},
		"order_custom_field_type_info": {
			"type": "object",
			"properties": {
				"short_label": {
					"type": "string",
					"title": "Short Label",
					"description": "Short label of the custom field (specified when order_custom_field_type=checkbox)."
				},
				"short_caption": {
					"type": "string",
					"title": "Short Caption",
					"description": "Short caption of the custom field (specified when order_custom_field_type=dropdown)."
				},
				"allowed_values": {
					"type": "array",
					"items": { "type": "string" },
					"title": "Short Values",
					"description": "Allowed values of the custom field (specified when order_custom_field_type=dropdown)."
				}
			},
			"title": "Order Custom Field Type Info",
			"description": "Information about an order's custom field. You can specify the propertiesof the different types in this property, but the property `short_label` is reserved - it specifies custom field column header in the orders table in the page: https://route4me.com/orders."
		}
	}
}