WC_REST_Order_Notes_V1_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_V1_Controller{}

No Hooks.

Return

Array.

Usage

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

WC_REST_Order_Notes_V1_Controller::get_item_schema() WC REST Order Notes V1 Controller::get item schema code ^{WC 9.8.1}

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,
			),
			'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,
			),
			'note' => array(
				'description' => __( 'Order note.', 'woocommerce' ),
				'type'        => 'string',
				'context'     => array( 'view', 'edit' ),
			),
			'customer_note' => array(
				'description' => __( 'Shows/define if the note is only for reference or for the customer (the user will be notified).', 'woocommerce' ),
				'type'        => 'boolean',
				'default'     => false,
				'context'     => array( 'view', 'edit' ),
			),
		),
	);

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