name/v$this->version", $this->endpoint . '/(?P\S+)/sync/', [ [ 'methods' => \WP_REST_Server::EDITABLE, 'callback' => $this->callback( $this->controller, 'sync' ), 'permission_callback' => [ $this, 'update_item_permissions_check' ], ], // Register our schema callback. 'schema' => [ $this, 'get_item_schema' ], ] ); register_rest_route( "$this->name/v$this->version", $this->endpoint . '/sync_all', [ [ 'methods' => \WP_REST_Server::EDITABLE, 'callback' => $this->callback( $this->controller, 'syncAll' ), 'permission_callback' => [ $this, 'update_item_permissions_check' ], ], // Register our schema callback. 'schema' => [ $this, 'get_item_schema' ], ] ); register_rest_route( "$this->name/v$this->version", $this->endpoint . '/(?P\S+)/duplicate', [ 'methods' => \WP_REST_Server::CREATABLE, 'callback' => $this->callback( $this->controller, 'duplicate' ), 'permission_callback' => [ $this, 'create_item_permissions_check' ], ] ); register_rest_route( "$this->name/v$this->version", $this->endpoint . '/import_woocommerce', [ [ 'methods' => \WP_REST_Server::CREATABLE, 'callback' => $this->callback( $this->controller, 'importWooCommerce' ), 'permission_callback' => [ $this, 'update_item_permissions_check' ], ], ] ); register_rest_route( "$this->name/v$this->version", $this->endpoint . '/woocommerce_count', [ [ 'methods' => \WP_REST_Server::READABLE, 'callback' => $this->callback( $this->controller, 'wooCommerceCount' ), // Uses edit-level permission (edit_sc_products) intentionally: admin-only import feature, only product editors should see the WooCommerce count. 'permission_callback' => [ $this, 'update_item_permissions_check' ], ], ] ); } /** * Get our sample schema for a post. * * @return array The sample schema for a post */ public function get_item_schema() { if ( $this->schema ) { // Since WordPress 5.3, the schema can be cached in the $schema property. return $this->schema; } $this->schema = [ // This tells the spec of JSON Schema we are using which is draft 4. '$schema' => 'http://json-schema.org/draft-04/schema#', // The title property marks the identity of the resource. 'title' => $this->endpoint, 'type' => 'object', // In JSON Schema you can specify object properties in the properties attribute. 'properties' => [ 'id' => [ 'description' => esc_html__( 'Unique identifier for the object.', 'surecart' ), 'type' => 'string', 'context' => [ 'view', 'edit', 'embed' ], 'readonly' => true, ], 'file_upload_ids' => [ 'description' => esc_html__( 'Files attached to the product.', 'surecart' ), 'context' => [ 'edit' ], 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'metadata' => [ 'description' => esc_html__( 'Stored product metadata', 'surecart' ), 'type' => 'object', 'context' => [ 'edit' ], 'properties' => [ 'wp_created_by' => [ 'type' => 'integer', 'context' => [ 'edit' ], 'readonly' => true, ], ], ], 'available_stock' => [ 'description' => esc_html__( 'The available stock for the product.', 'surecart' ), 'type' => 'integer', 'context' => [ 'edit' ], ], 'held_stock' => [ 'description' => esc_html__( 'The held stock for the product.', 'surecart' ), 'type' => 'integer', 'context' => [ 'edit' ], ], 'stock' => [ 'description' => esc_html__( 'The stock for the product.', 'surecart' ), 'type' => 'integer', 'context' => [ 'edit' ], ], 'status' => [ 'description' => esc_html__( 'The status of the product.', 'surecart' ), 'type' => 'string', 'context' => [ 'edit' ], ], 'archived' => [ 'description' => esc_html__( 'Whether the product is archived.', 'surecart' ), 'type' => 'boolean', 'context' => [ 'edit' ], ], 'archived_at' => [ 'description' => esc_html__( 'Archived at timestamp.', 'surecart' ), 'type' => 'integer', 'context' => [ 'edit' ], ], 'discarded_at' => [ 'description' => esc_html__( 'Discarded at timestamp.', 'surecart' ), 'type' => 'integer', 'context' => [ 'edit' ], ], 'cataloged_at' => [ 'description' => esc_html__( 'Cataloged at timestamp.', 'surecart' ), 'type' => 'integer', 'context' => [ 'edit' ], ], 'sku' => [ 'description' => esc_html__( 'The product SKU.', 'surecart' ), 'type' => 'string', 'context' => [ 'edit' ], ], 'dimensions' => [ 'description' => esc_html__( 'The product shipping dimensions.', 'surecart' ), 'type' => 'object', 'context' => [ 'edit' ], ], 'weight' => [ 'description' => esc_html__( 'The product shipping weight.', 'surecart' ), 'type' => 'number', 'context' => [ 'edit' ], ], 'weight_unit' => [ 'description' => esc_html__( 'The product shipping weight unit.', 'surecart' ), 'type' => 'string', 'context' => [ 'edit' ], ], 'tax_category' => [ 'description' => esc_html__( 'The product tax category.', 'surecart' ), 'type' => 'string', 'context' => [ 'edit' ], ], 'tax_enabled' => [ 'description' => esc_html__( 'Whether tax is enabled for the product.', 'surecart' ), 'type' => 'boolean', 'context' => [ 'edit' ], ], 'purchase_limit' => [ 'description' => esc_html__( 'The purchase limit for the product.', 'surecart' ), 'type' => 'integer', 'context' => [ 'edit' ], ], 'metrics' => [ 'description' => esc_html__( 'Top level metrics for the product.', 'surecart' ), 'readonly' => true, 'type' => 'object', 'properties' => [ 'currency' => [ 'type' => 'string', ], 'max_price_amount' => [ 'type' => 'integer', ], 'min_price_amount' => [ 'type' => 'integer', ], 'prices_count' => [ 'type' => 'integer', ], ], // public price aggregates — the product list renders price ranges from these. 'context' => [ 'view', 'edit', 'embed' ], ], ], ]; return $this->schema; } /** * Get the collection params. * * @return array */ public function get_collection_params() { $args = [ 'archived' => [ 'description' => esc_html__( 'Whether to get archived products or not.', 'surecart' ), 'type' => 'boolean', ], 'recurring' => [ 'description' => esc_html__( 'Only return products that are recurring or not recurring (one time).', 'surecart' ), 'type' => 'boolean', ], 'bundle' => [ 'description' => esc_html__( 'Only return bundle products (true) or non-bundle products (false).', 'surecart' ), 'type' => 'boolean', ], 'query' => [ 'description' => __( 'The query to be used for full text search of this collection.', 'surecart' ), 'type' => 'string', ], 'sort' => [ 'description' => __( 'Sort directive in the form `field:direction`, e.g. `cataloged_at:desc`.', 'surecart' ), 'type' => 'string', ], 'expand' => [ 'description' => __( 'Relations to expand on each returned product.', 'surecart' ), 'type' => 'array', 'items' => [ 'type' => 'string', ], 'default' => [], ], 'expand_mode' => [ 'description' => __( 'Whether `expand` augments the default relations (`merge`) or replaces them (`replace`).', 'surecart' ), 'type' => 'string', 'enum' => [ 'merge', 'replace' ], 'default' => 'merge', ], 'ids' => [ 'description' => __( 'Ensure result set excludes specific IDs.', 'surecart' ), 'type' => 'array', 'items' => [ 'type' => 'string', ], 'default' => [], ], 'product_group_ids' => [ 'description' => __( 'Only return objects that belong to the given product groups.', 'surecart' ), 'type' => 'array', 'items' => [ 'type' => 'string', ], 'default' => [], ], 'product_collection_ids' => [ 'description' => __( 'Only return objects that belong to the given product collections.', 'surecart' ), 'type' => 'array', 'items' => [ 'type' => 'string', ], 'default' => [], ], 'page' => [ 'description' => esc_html__( 'The page of items you want returned.', 'surecart' ), 'type' => 'integer', ], 'per_page' => [ 'description' => esc_html__( 'A limit on the number of items to be returned, between 1 and 100.', 'surecart' ), 'type' => 'integer', ], ]; /** * Filter the products REST collection params. * * Allows plugins to register additional query args (e.g. custom * metadata filters) without forking the controller. * * @param array $args Args keyed by param name. * @return array */ return apply_filters( 'surecart/products/rest_args', $args ); } /** * Anyone can get a specific product. * * @param \WP_REST_Request $request Full details about the request. * @return true|\WP_Error True if the request has access to create items, WP_Error object otherwise. */ public function get_item_permissions_check( $request ) { $check = $this->forbidEditContextWithout( $request, 'edit_sc_products' ); if ( is_wp_error( $check ) ) { return $check; } return true; } /** * Who can list products? * * @param \WP_REST_Request $request Full details about the request. * @return true|\WP_Error True if the request has access to create items, WP_Error object otherwise. */ public function get_items_permissions_check( $request ) { $check = $this->forbidEditContextWithout( $request, 'edit_sc_products' ); if ( is_wp_error( $check ) ) { return $check; } if ( $request['archived'] ) { return current_user_can( 'edit_sc_products' ); } return true; } /** * Create model. * * @param \WP_REST_Request $request Full details about the request. * @return true|\WP_Error True if the request has access to create items, WP_Error object otherwise. */ public function create_item_permissions_check( $request ) { $request['context'] = 'edit'; return current_user_can( 'publish_sc_products' ); } /** * Update model. * * @param \WP_REST_Request $request Full details about the request. * @return true|\WP_Error True if the request has access to create items, WP_Error object otherwise. */ public function update_item_permissions_check( $request ) { $request['context'] = 'edit'; return current_user_can( 'edit_sc_products' ); } /** * Delete model. * * @param \WP_REST_Request $request Full details about the request. * @return true|\WP_Error True if the request has access to create items, WP_Error object otherwise. */ public function delete_item_permissions_check( $request ) { $request['context'] = 'edit'; return current_user_can( 'delete_sc_products' ); } /** * If we are editing, let's make sure the data comes back directly. * * @param \SureCart\Models\Product $model Product model. * @param string $context The context of the request. * * @return array The filtered response. */ public function filter_response_by_context( $model, $context ) { $response = parent::filter_response_by_context( $model, $context ); if ( ! is_array( $response ) || empty( $response['id'] ) ) { return $response; } if ( 'edit' === $context ) { // Process the variants, it's in a data column, so we need to pull it out. $response['variants'] = ! empty( $response['variants']['data'] ) ? $response['variants']['data'] : []; // Process the variant_options, it's in a data column, so we need to pull it out. $response['variant_options'] = ! empty( $response['variant_options']['data'] ) ? $response['variant_options']['data'] : []; return $response; } // view/embed: strip private data the schema can't reach on expansions. return $this->stripPrivateProductFields( $response ); } }