Automattic\WooCommerce\Internal\Fulfillments

OrderFulfillmentsRestController::get_schema_for_get_tracking_number_details │ private │ WC 1.0

Get the schema for the get tracking number details endpoint.

Method of the class: OrderFulfillmentsRestController{}

No Hooks.

Returns

Array.

Usage

// private - for code of main (parent) class only
$result = $this->get_schema_for_get_tracking_number_details(): array;

OrderFulfillmentsRestController::get_schema_for_get_tracking_number_details() code WC 10.3.3

woocommerce/src/Internal/Fulfillments/OrderFulfillmentsRestController.php 
private function get_schema_for_get_tracking_number_details(): array {
	$schema               = $this->get_base_schema();
	$schema['title']      = __( 'The tracking number details response.', 'woocommerce' );
	$schema['properties'] = array(
		'tracking_number'   => array(
			'description' => __( 'The tracking number.', 'woocommerce' ),
			'type'        => 'string',
			'required'    => true,
		),
		'shipping_provider' => array(
			'description' => __( 'The shipping provider.', 'woocommerce' ),
			'type'        => 'string',
			'required'    => true,
		),
		'tracking_url'      => array(
			'description' => __( 'The tracking URL.', 'woocommerce' ),
			'type'        => 'string',
			'required'    => true,
		),
		'possibilities'     => array(
			'description' => __( 'Ambiguous shipping providers list.', 'woocommerce' ),
			'type'        => 'array',
			'required'    => false,
			'items'       => array(
				'type' => 'string',
			),
		),
	);
	return $schema;
}