WC_REST_Order_Notes_Controller::get_item_schema() │ public │ WC 1.0

Get the Order Notes schema, conforming to JSON Schema.

Method of the class: WC_REST_Order_Notes_Controller{}

No Hooks.

Return

Array.

Usage

$WC_REST_Order_Notes_Controller = new WC_REST_Order_Notes_Controller();
$WC_REST_Order_Notes_Controller->get_item_schema();

WC_REST_Order_Notes_Controller::get_item_schema() WC REST Order Notes Controller::get item schema code ^{WC 8.7.0}

public function get_item_schema() {
	$schema = array(
		'$schema'    => 'http://json-schema.org/draft-04/schema#',
		'title'      => 'order_note',
		'type'       => 'object',
		'properties' => array(
			'id'               => array(
				'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
				'type'        => 'integer',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'author'           => array(
				'description' => __( 'Order note author.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'date_created'     => array(
				'description' => __( "The date the order note was created, in the site's timezone.", 'woocommerce' ),
				'type'        => 'date-time',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'date_created_gmt' => array(
				'description' => __( 'The date the order note was created, as GMT.', 'woocommerce' ),
				'type'        => 'date-time',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'note'             => array(
				'description' => __( 'Order note content.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view', 'edit' ),
			),
			'customer_note'    => array(
				'description' => __( 'If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.', 'woocommerce' ),
				'type'        => 'boolean',
				'default'     => false,
				'context'     => array( 'view', 'edit' ),
			),
			'added_by_user'    => array(
				'description' => __( 'If true, this note will be attributed to the current user. If false, the note will be attributed to the system.', 'woocommerce' ),
				'type'        => 'boolean',
				'default'     => false,
				'context'     => array( 'edit' ),
			),
		),
	);

	return $this->add_additional_fields_schema( $schema );
}