# woocommerce-pos/1.10.18/includes/API/V1/Receipts_Controller.php

WCPOS – Point of Sale (POS) plugin for WooCommerce, version 1.10.18. 243 lines.

- Page: https://pluginprobe.com/plugins/woocommerce-pos/1.10.18/code/includes/API/V1/Receipts_Controller.php
- Raw: https://pluginprobe.com/plugins/woocommerce-pos/1.10.18/raw/includes/API/V1/Receipts_Controller.php
- Modified: 2026-08-25T07:52:20+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/woocommerce-pos/1.10.18/code/includes/API/V1/Receipts_Controller.php#L10-L20`.

```php
<?php
/**
 * Receipts REST controller.
 *
 * @package WCPOS\WooCommercePOS\API\V1
 */

namespace WCPOS\WooCommercePOS\API\V1;

use WCPOS\WooCommercePOS\Logger;
use WCPOS\WooCommercePOS\Services\Print_Job_Service;
use WCPOS\WooCommercePOS\Services\Receipt_Data_Builder;
use WCPOS\WooCommercePOS\Services\Receipt_Snapshot_Store;
use WCPOS\WooCommercePOS\Services\Fiscal_Receipt_Service;
use WCPOS\WooCommercePOS\Services\Template_Pdf_Service;
use WP_Error;
use WP_REST_Controller;
use WP_REST_Request;
use WP_REST_Server;

use const WCPOS\WooCommercePOS\SHORT_NAME;

/**
 * Receipts_Controller class.
 */
class Receipts_Controller extends WP_REST_Controller {
	/**
	 * Endpoint namespace.
	 *
	 * @var string
	 */
	protected $namespace = SHORT_NAME . '/v1';

	/**
	 * Route base.
	 *
	 * @var string
	 */
	protected $rest_base = 'receipts';

	/**
	 * Declare routes with special permission-gate handling.
	 *
	 * @return array<string, string[]> Route classifications.
	 */
	public function wcpos_route_classifications(): array {
		return array(
			'permission_error_passthrough' => array( "/{$this->namespace}/{$this->rest_base}/" ),
		);
	}

	/**
	 * Register routes.
	 */
	public function register_routes(): void {
		register_rest_route(
			$this->namespace,
			'/' . $this->rest_base . '/(?P<order_id>[\\d]+)',
			array(
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => array( $this, 'get_item' ),
				'permission_callback' => array( $this, 'get_item_permissions_check' ),
				'args'                => array(
					'order_id' => array(
						'type'              => 'integer',
						'required'          => true,
						'sanitize_callback' => 'absint',
					),
					'mode'     => array(
						'type'              => 'string',
						'required'          => false,
						'enum'              => array( 'fiscal', 'live' ),
						'sanitize_callback' => 'sanitize_text_field',
					),
				),
			)
		);

		register_rest_route(
			$this->namespace,
			'/' . $this->rest_base . '/(?P<order_id>[\\d]+)/pdf',
			array(
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => array( $this, 'get_pdf' ),
				'permission_callback' => array( $this, 'get_item_permissions_check' ),
				'args'                => array(
					'order_id'    => array(
						'type'              => 'integer',
						'required'          => true,
						'sanitize_callback' => 'absint',
					),
					'template_id' => array(
						'type'              => 'string',
						'required'          => true,
						'sanitize_callback' => 'sanitize_text_field',
					),
				),
			)
		);
	}

	/**
	 * Get receipt payload for an order.
	 *
	 * @param WP_REST_Request $request Request object.
	 *
	 * @return array|WP_Error
	 */
	public function get_item( $request ) {
		$order_id = (int) $request->get_param( 'order_id' );
		$order    = wc_get_order( $order_id );

		if ( ! $order ) {
			return new WP_Error(
				'wcpos_receipt_invalid_order',
				/* translators: REST API schema field label or error message. */
				__( 'Invalid order.', 'woocommerce-pos' ),
				array( 'status' => 404 )
			);
		}

		$snapshot_store = Receipt_Snapshot_Store::instance();
		$requested_mode = $request->get_param( 'mode' );
		if ( null !== $requested_mode && ! \in_array( $requested_mode, array( 'fiscal', 'live' ), true ) ) {
			return new WP_Error(
				'wcpos_receipt_invalid_mode',
				/* translators: REST API schema field label or error message. */
				__( 'Invalid receipt mode.', 'woocommerce-pos' ),
				array( 'status' => 400 )
			);
		}

		$mode    = $snapshot_store->resolve_mode( $requested_mode );
		$payload        = null;

		if ( 'fiscal' === $mode ) {
			$payload = $snapshot_store->get_snapshot( $order_id );
			if ( ! $payload ) {
				return new WP_Error(
					'wcpos_receipt_snapshot_missing',
					__( 'No fiscal snapshot found for this order.', 'woocommerce-pos' ),
					array( 'status' => 404 )
				);
			}
		} else {
			$payload = ( new Receipt_Data_Builder() )->build( $order, 'live' );
		}

		return array(
			'order_id'     => $order_id,
			'mode'         => $mode,
			'has_snapshot' => $snapshot_store->has_snapshot( $order_id ),
			'submission_status' => ( new Fiscal_Receipt_Service() )->get_submission_status( $order_id ),
			'data'         => $payload,
		);
	}

	/**
	 * Get receipt PDF bytes for an order.
	 *
	 * @param WP_REST_Request $request Request object.
	 *
	 * @return Raw_Response|WP_Error
	 */
	public function get_pdf( $request ) {
		$order = wc_get_order( (int) $request['order_id'] );
		if ( ! $order ) {
			return new WP_Error(
				'wcpos_receipt_order_not_found',
				__( 'Order not found.', 'woocommerce-pos' ),
				array( 'status' => 404 )
			);
		}

		$template_id = trim( (string) $request->get_param( 'template_id' ) );
		if ( '' === $template_id ) {
			return new WP_Error(
				'wcpos_receipt_missing_template',
				__( 'A template_id is required.', 'woocommerce-pos' ),
				array( 'status' => 400 )
			);
		}

		$template = Print_Job_Service::load_template( $template_id );
		if ( null === $template ) {
			return new WP_Error(
				'wcpos_receipt_template_not_found',
				__( 'Template not found.', 'woocommerce-pos' ),
				array( 'status' => 404 )
			);
		}

		try {
			$pdf = ( new Template_Pdf_Service() )->render( $template, $order );
		} catch ( \Throwable $e ) {
			Logger::log( sprintf( 'Receipt PDF render failed for order %d: %s', $order->get_id(), $e->getMessage() ) );

			return new WP_Error(
				'wcpos_receipt_pdf_failed',
				__( 'Could not generate the receipt PDF.', 'woocommerce-pos' ),
				array( 'status' => 500 )
			);
		}

		if ( '' === $pdf ) {
			return new WP_Error(
				'wcpos_receipt_pdf_empty',
				__( 'Could not generate the receipt PDF.', 'woocommerce-pos' ),
				array( 'status' => 500 )
			);
		}

		return Raw_Response::serve(
			$pdf,
			'application/pdf',
			array(
				'Content-Disposition' => sprintf( 'attachment; filename="receipt-%d.pdf"', $order->get_id() ),
				'Content-Length'      => (string) \strlen( $pdf ),
				'Cache-Control'       => 'no-store',
			)
		);
	}

	/**
	 * Permissions check.
	 *
	 * @param WP_REST_Request $request Request object.
	 *
	 * @return bool|WP_Error
	 */
	public function get_item_permissions_check( $request ) {
		if ( ! current_user_can( 'access_woocommerce_pos' ) ) {
			return new WP_Error(
				'wcpos_rest_insufficient_permissions',
				__( 'Sorry, you cannot view receipts.', 'woocommerce-pos' ),
				array( 'status' => 403 )
			);
		}

		return true;
	}
}

```