Automattic\WooCommerce\Internal\RestApi\Routes\V4\OrderNotes\Schema

OrderNoteSchema::get_item_schema_properties │ public │ WC 1.0

Return all properties for the item schema.

Note that context determines under which context data should be visible. For example, edit would be the context used when getting records with the intent of editing them. embed context allows the data to be visible when the item is being embedded in another response.

Method of the class: OrderNoteSchema{}

No Hooks.

Returns

Array.

Usage

$OrderNoteSchema = new OrderNoteSchema();
$OrderNoteSchema->get_item_schema_properties(): array;

OrderNoteSchema::get_item_schema_properties() OrderNoteSchema::get item schema properties code ^{WC 10.4.3}

public function get_item_schema_properties(): array {
	$schema = array(
		'id'               => array(
			'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
			'type'        => 'integer',
			'context'     => self::VIEW_EDIT_EMBED_CONTEXT,
			'readonly'    => true,
		),
		'order_id'         => array(
			'description' => __( 'Order ID the note belongs to.', 'woocommerce' ),
			'type'        => 'integer',
			'context'     => self::VIEW_EDIT_CONTEXT,
			'readonly'    => true,
		),
		'author'           => array(
			'description' => __( 'Order note author.', 'woocommerce' ),
			'type'        => 'string',
			'context'     => self::VIEW_EDIT_EMBED_CONTEXT,
			'readonly'    => true,
		),
		'date_created'     => array(
			'description' => __( "The date the order note was created, in the site's timezone.", 'woocommerce' ),
			'type'        => 'string',
			'format'      => 'date-time',
			'context'     => self::VIEW_EDIT_EMBED_CONTEXT,
			'readonly'    => true,
		),
		'date_created_gmt' => array(
			'description' => __( 'The date the order note was created, as GMT.', 'woocommerce' ),
			'type'        => 'string',
			'format'      => 'date-time',
			'context'     => self::VIEW_EDIT_EMBED_CONTEXT,
			'readonly'    => true,
		),
		'note'             => array(
			'description' => __( 'Order note content.', 'woocommerce' ),
			'type'        => 'string',
			'context'     => self::VIEW_EDIT_EMBED_CONTEXT,
			'required'    => true,
		),
		'title'            => array(
			'description' => __( 'The title of the order note group.', 'woocommerce' ),
			'type'        => 'string',
			'context'     => self::VIEW_EDIT_EMBED_CONTEXT,
			'readonly'    => true,
		),
		'group'            => array(
			'description' => __( 'The group of order note.', 'woocommerce' ),
			'type'        => 'string',
			'context'     => self::VIEW_EDIT_EMBED_CONTEXT,
			'readonly'    => true,
		),
		'is_customer_note' => array(
			'description' => __( 'If true, the note will be shown to customers. If false, the note will be for admin reference only.', 'woocommerce' ),
			'type'        => 'boolean',
			'default'     => false,
			'context'     => self::VIEW_EDIT_EMBED_CONTEXT,
		),
	);

	return $schema;
}